User API Doc¶
IdentityServicesEngineAPI¶
The IdentityServicesEngineAPI
class creates “connection objects” for working with the Identity Services Engine APIs and hierarchically organizes the Identity Services Engine APIs and their endpoints underneath these connection objects.
IdentityServicesEngineAPI summary structure¶
v3.1.0 summary¶
v3.1.1 summary¶
IdentityServicesEngineAPI Class¶
-
class
IdentityServicesEngineAPI
[source]¶ Identity Services Engine API wrapper.
Creates a ‘session’ for all API calls through a created IdentityServicesEngineAPI object. The ‘session’ handles authentication, provides the needed headers, and checks all responses for error conditions.
IdentityServicesEngineAPI wraps all of the individual Identity Services Engine APIs and represents them in a simple hierarchical structure.
-
__init__
(username=None, password=None, encoded_auth=None, uses_api_gateway=None, base_url=None, ui_base_url=None, ers_base_url=None, mnt_base_url=None, px_grid_base_url=None, single_request_timeout=None, wait_on_rate_limit=None, verify=None, version=None, debug=None, uses_csrf_token=None, object_factory=<function mydict_data_factory>, validator=<class 'ciscoisesdk.models.schema_validator.SchemaValidator'>, perform_initialize=True)[source]¶ Create a new IdentityServicesEngineAPI object. An access token is required to interact with the Identity Services Engine APIs. This package supports two methods for you to pass the authorization token:
1. Provide a encoded_auth value (username:password encoded in base 64). This has priority over the following method
Provide username and password values.
This package supports two methods for you to set those values:
1. Provide the parameter. That is the encoded_auth or username and password parameters.
2. If an argument is not supplied, the package checks for its environment variable counterpart. That is the IDENTITY_SERVICES_ENGINE_ENCODED_AUTH, IDENTITY_SERVICES_ENGINE_USERNAME, IDENTITY_SERVICES_ENGINE_PASSWORD.
When not given enough parameters an AccessTokenError is raised.
- Parameters
uses_api_gateway (bool,basestring) – Controls whether we use the ISE’s API Gateway to make the request. Defaults to the IDENTITY_SERVICES_ENGINE_USES_API_GATEWAY (or IDENTITY_SERVICES_ENGINE_USES_API_GATEWAY_STRING) environment variable or ciscoisesdk.config.DEFAULT_USES_API_GATEWAY if the environment variables are not set.
base_url (basestring) – The base URL to be prefixed to the individual API endpoint suffixes, used when uses_api_gateway is True. Defaults to the IDENTITY_SERVICES_ENGINE_BASE_URL environment variable or ciscoisesdk.config.DEFAULT_BASE_URL if the environment variable is not set.
ui_base_url (basestring) – The UI base URL to be prefixed to the individual ISE UI API endpoint suffixes, used when uses_api_gateway is False. Defaults to the IDENTITY_SERVICES_ENGINE_BASE_URL environment variable if set.
ers_base_url (basestring) – The ERS base URL to be prefixed to the individual ISE ERS API endpoint suffixes, used when uses_api_gateway is False. Defaults to the IDENTITY_SERVICES_ENGINE_BASE_URL environment variable if set.
mnt_base_url (basestring) – The MNT base URL to be prefixed to the individual ISE MNT API endpoint suffixes, used when uses_api_gateway is False. Defaults to the IDENTITY_SERVICES_ENGINE_BASE_URL environment variable if set.
px_grid_base_url (basestring) – The PxGrid base URL to be prefixed to the individual ISE PxGrid API endpoint suffixes, used when uses_api_gateway is False. Defaults to the IDENTITY_SERVICES_ENGINE_BASE_URL environment variable if set.
username (basestring) – HTTP Basic Auth username.
password (basestring) – HTTP Basic Auth password.
encoded_auth (basestring) – HTTP Basic Auth base64 encoded string.
single_request_timeout (int) – Timeout (in seconds) for RESTful HTTP requests. Defaults to the IDENTITY_SERVICES_ENGINE_SINGLE_REQUEST_TIMEOUT environment variable or ciscoisesdk.config.DEFAULT_SINGLE_REQUEST_TIMEOUT if the environment variable is not set.
wait_on_rate_limit (bool) – Enables or disables automatic rate-limit handling. Defaults to the IDENTITY_SERVICES_ENGINE_WAIT_ON_RATE_LIMIT environment variable or ciscoisesdk.config.DEFAULT_WAIT_ON_RATE_LIMIT if the environment variable is not set.
verify (bool,basestring) – Controls whether we verify the server’s TLS certificate, or a string, in which case it must be a path to a CA bundle to use. Defaults to the IDENTITY_SERVICES_ENGINE_VERIFY (or IDENTITY_SERVICES_ENGINE_VERIFY_STRING) environment variable or ciscoisesdk.config.DEFAULT_VERIFY if the environment variables are not set.
version (basestring) – Controls which version of IDENTITY_SERVICES_ENGINE to use. Defaults to the IDENTITY_SERVICES_ENGINE_VERSION environment variable or ciscoisesdk.config.DEFAULT_VERSION if the environment variable is not set.
debug (bool,basestring) – Controls whether to log information about Identity Services Engine APIs’ request and response process. Defaults to the IDENTITY_SERVICES_ENGINE_DEBUG environment variable or False if the environment variable is not set.
uses_csrf_token (bool,basestring) – Controls whether we send the CSRF token to ISE’s ERS APIs. Defaults to the IDENTITY_SERVICES_ENGINE_USES_CSRF_TOKEN environment variable or ciscoisesdk.config.DEFAULT_USES_CSRF_TOKEN if the environment variables are not set.
object_factory (callable) – The factory function to use to create Python objects from the returned Identity Services Engine JSON data objects.
validator (callable) – The factory class with function json_schema_validate(model:string) that returns an object with function validate(obj:dict) is used to validate Python objects sent in the request body.
perform_initialize (bool) – The flag that, if enabled, initializes now all the related objects to manage information from Identity Services Engine, like the authentication, the sessions (requests library), and the API wrappers (for each ISE API family). Defaults to True. You can initialize/reinitialize later with reinitialize. The original value will not change.
- Returns
A new IdentityServicesEngineAPI object.
- Return type
- Raises
TypeError – If the parameter types are incorrect.
AccessTokenError – If an access token is not provided via the access_token argument or an environment variable.
VersionError – If the version is not provided via the version argument or an environment variable, or it is not a Identity Services Engine API supported version [‘3.1.0’, ‘3.1.1’].
-
initialize_authentication
()[source]¶ Function used when perform_initialize is True in class init. Init Authentication wrapper early to use for basicAuth requests.
-
initialize_sessions
()[source]¶ Performs initialization of “session_ui”, “session_ers”, “session”, “session_mnt”, “session_px_grid” properties. Creating for each one a RestSession object that handles the requests.
-
reinitialize
()[source]¶ Calls all the methods necessary to initialize/reinitialize the IdentityServicesEngineAPI.
-
property
authentication
¶ Utility object that provides authentication method.
-
property
perform_initialize
¶ The flag that, if enabled, initialized in the constructor all the related objects to manage information from Identity Services Engine.
-
property
session
¶ The Identity Services Engine API session.
-
property
session_ui
¶ The Identity Services Engine UI API session.
-
property
session_ers
¶ The Identity Services Engine ERS API session.
-
property
session_mnt
¶ The Identity Services Engine MNT API session.
-
property
session_px_grid
¶ The Identity Services Engine PxGrid API session.
-
property
username
¶ HTTP Basic Auth username
-
change_password
(password)[source]¶ HTTP Basic Auth password.
It may require to call reinitialize to distribute the changes accross the SDK objects.
-
change_encoded_auth
(encoded_auth)[source]¶ HTTP Basic Auth base64 encoded string.
It may require to call reinitialize to distribute the changes accross the SDK objects.
-
property
uses_api_gateway
¶ If the Identity Services Engine API uses an API Gateway.
-
property
base_url
¶ The base URL prefixed to the individual API endpoint suffixes for ERS and Custom Caller operations.
-
property
ui_base_url
¶ The ui base URL prefixed to the individual API endpoint suffixes for UI operations.
-
property
ers_base_url
¶ The ers base URL prefixed to the individual API endpoint suffixes for ERS operations.
-
property
mnt_base_url
¶ The mnt base URL prefixed to the individual API endpoint suffixes for MNT operations.
-
property
px_grid_base_url
¶ The px_grid base URL prefixed to the individual API endpoint suffixes for PxGrid operations
-
property
single_request_timeout
¶ Timeout (in seconds) for an single HTTP request.
-
property
wait_on_rate_limit
¶ Automatic rate-limit handling enabled / disabled.
-
property
verify
¶ The verify (TLS Certificate) for the API endpoints.
-
property
version
¶ The API version of Identity Services Engine.
-
property
debug
¶ If log information about Identity Services Engine APIs’ request and response process is shown.
-
property
uses_csrf_token
¶ If the Identity Services Engine ERS API requires the X-CSRF-Token to be sent.
-
property
object_factory
¶ The factory function to use to create Python objects from the returned Identity Services Engine JSON data objects.
-
property
validator
¶ The function used to validate Python objects sent in the request body.
-
authentication¶
-
class
Authentication
[source]¶ Identity Services Engine Authentication API.
Wraps the Identity Services Engine Authentication API and exposes the API as native Python methods that return native Python objects.
-
property
verify
¶ The verify (TLS Certificate) for the API endpoints.
-
property
base_url
¶ The base URL for the API endpoints.
-
property
single_request_timeout
¶ Timeout in seconds for the API requests.
-
authentication_api
(username, password, encoded_auth=None)[source]¶ Exchange basic auth data for a Authorization Basic encoded value that can be used to invoke the APIs.
- Parameters
username (basestring) – HTTP Basic Auth username.
password (basestring) – HTTP Basic Auth password.
encoded_auth (basestring) – HTTP Basic Auth base64 encoded string.
- Returns
An AccessToken object with the access token provided by the Identity Services Engine cloud.
- Return type
AccessToken
- Raises
TypeError – If the parameter types are incorrect.
-
property
custom_caller¶
-
class
CustomCaller
[source]¶ Identity Services Engine CustomCaller.
Identity Services Engine CustomCaller allows API creation.
-
call_api
(method, resource_path, raise_exception=True, original_response=False, **kwargs)[source]¶ Handles the requests and response.
- Parameters
method (basestring) – type of request.
resource_path (basestring) – URL in the request object.
raise_exception (bool) – If True, http exceptions will be raised.
original_response (bool) – If True, MyDict (JSON response) is returned, else response object.
path_params (dict) (optional) – Find each path_params’ key in the resource_path and replace it with path_params’ value.
params (optional) – Dictionary or bytes to be sent in the query string for the Request.
data (optional) – Dictionary, bytes, or file-like object to send in the body of the Request.
json (optional) – json data to send in the body of the Request.
headers (optional) – Dictionary of HTTP Headers to send with the Request.
cookies (optional) – Dict or CookieJar object to send with the Request.
files (optional) – Dictionary of ‘name’: file-like-objects (or {‘name’: (‘filename’, fileobj)}) for multipart encoding upload.
auth (optional) – Auth tuple to enable Basic/Digest/Custom HTTP Auth.
timeout (float, tuple) (optional) – How long to wait for the server to send data before giving up, as a float, or a (connect timeout, read timeout) tuple.
allow_redirects (bool) (optional) – bool. Set to True if POST/PUT/DELETE redirect following is allowed.
proxies (optional) – Dictionary mapping protocol to the URL of the proxy.
verify (bool,string) (optional) – if True, the SSL cert will be verified. A CA_BUNDLE path can also be provided as a string.
stream (optional) – if False, the response content will be immediately downloaded.
cert (basestring, tuple) (optional) – if String, path to ssl client cert file (.pem). If Tuple, (‘cert’, ‘key’) pair
- Returns
If original_response is True returns the original object response, else returns a JSON response with access to the object’s properties by using the dot notation or the bracket notation. Defaults to False.
- Return type
- Raises
TypeError – If the parameter types are incorrect.
HTTPError – If the Identity Services Engine cloud returns an error.
-
IdentityServicesEngineAPI v3.1.0¶
aci_bindings¶
-
class
AciBindings
[source]¶ Identity Services Engine ACIBindings API (version: 3.1.0).
Wraps the Identity Services Engine ACIBindings API and exposes the API as native Python methods that return native Python objects.
The ACI Bindings API allows clients to retrieve bindings that were sent to Cisco ISE by ACI or received on ACI from Cisco ISE. The binding information will be identical to the information on the ACI bindings page in the Cisco ISE UI. Filtering will be based on one attribute only, such as ip, sgt, vn, psn, learnedFrom, or learnedBy with CONTAINS mode of search.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
3.0
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Example Values
name
String
Yes
Resource Name
id
String
No
Resource UUID value
f9269682-dcaf-11e3-ad0a-5bdcd2d9fd69
description
String
No
ip
String
Yes
Binding IPv4 address. Each binding will be exclusively identified by its IP address and virtual network
10.0.0.1
sgt
String
No
Security Group Tag (SGT) value. The valid range for SGT values is 0-65534
1234
vn
String
Yes
Virtual network. Each binding will be exclusively identified by its IP address and virtual network
vn1234
psn
String
No
Cisco ISE Policy Service node (PSN) IP address
10.86.189.216
learnedFrom
String
Yes
Binding Source
ISE by ACI ACI by ISE
learnedBy
String
Yes
Binding Type
SXP(SXP, 0) STATIC(Static, 1) RADIUS(RADIUS, 2) ACI(ACI, 3)
-
get_aci_bindings
(filter_by=None, filter_value=None, page=None, size=None, sort=None, sort_by=None, headers=None, **query_parameters)[source]¶ This API allows clients to retrieve all the bindings that were sent to Cisco ISE by ACI or received on ACI from Cisco ISE.The binding information will be identical to the information on ACI bindings page in the Cisco ISE UI. Filtering will be based on one attribute only, such as ip/sgt/vn/psn/learnedFrom/learnedBy with CONTAINS mode of search.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sort (basestring) – sort query parameter. sort type asc or desc.
sort_by (basestring) – sortBy query parameter. sort column by which objects needs to be sorted.
filter_by (basestring, list, set, tuple) – filterBy query parameter.
filter_value (basestring, list, set, tuple) – filterValue query parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter_by=None, filter_value=None, page=None, size=None, sort=None, sort_by=None, headers=None, **query_parameters)[source]¶ Alias for get_aci_bindings
-
get_aci_bindings_generator
(filter_by=None, filter_value=None, page=None, size=None, sort=None, sort_by=None, headers=None, **query_parameters)[source]¶ This API allows clients to retrieve all the bindings that were sent to Cisco ISE by ACI or received on ACI from Cisco ISE.The binding information will be identical to the information on ACI bindings page in the Cisco ISE UI. Filtering will be based on one attribute only, such as ip/sgt/vn/psn/learnedFrom/learnedBy with CONTAINS mode of search.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sort (basestring) – sort query parameter. sort type asc or desc.
sort_by (basestring) – sortBy query parameter. sort column by which objects needs to be sorted.
filter_by (basestring, list, set, tuple) – filterBy query parameter.
filter_value (basestring, list, set, tuple) – filterValue query parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter_by=None, filter_value=None, page=None, size=None, sort=None, sort_by=None, headers=None, **query_parameters)[source]¶ Alias for get_aci_bindings_generator
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the Cisco ACI bindings.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
aci_settings¶
-
class
AciSettings
[source]¶ Identity Services Engine ACISettings API (version: 3.1.0).
Wraps the Identity Services Engine ACISettings API and exposes the API as native Python methods that return native Python objects.
ACI Settings API allows the client to get and update the ACI Settings. In addition, testing the ACI Domain Manager connection is also possible using the TestACIConnection.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
3.0
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Default Values
Example Values
name
String
Yes
Resource Name
AciSettings
id
String
No
Resource UUID value
29fb45ab-6a8e-4658-8a28-02521c258178
description
String
No
Aci Settings
enableAci
Boolean
Yes
Enable ACI Integration
false
isAci50
Boolean
Yes
Enable 5.0 ACI Version
false
ipAddressHostName
String
No
ACI Cluster IP Address / Host name
adminName
String
No
ACI Cluster Admin name
adminPassword
String
No
ACI Cluster Admin password
tenantName
String
No
ACI Cluster Tenant name
ISE
l3RouteNetwork
String
No
ACI Cluster L3 Route network name
L3_ROUTE
suffixToEpg
String
No
Name Conversion - EPG suffix
SGT
suffixToSgt
String
No
Name Conversion - SGT suffix
EPG
allSxpDomain
Boolean
No
SXP Propagation to all the SXP domains
false
specificSxpDomain
Boolean
No
SXP Propagation to specific SXP domains
true
specifixSxpDomainList
List
No
Specific SXP domains list
[default]
isAci51
Boolean
Yes
Enable 5.1 ACI Version
false
aciipaddress
String
No
ACI Domain manager Ip Address
aciuserName
String
No
ACI Domain manager Username
acipassword
String
No
ACI Domain manager Password
enableDataPlane
Boolean
No
Enable data plane
false
untaggedPacketIepgName
String
No
Untagged IEPG packets name
untagged
defaultSgtName
String
No
Default SGT name
Unknown
enableElementsLimit
Boolean
No
Enable Elements Limit
false
maxNumIepgFromAci
Integer
No
Max number of IEPGs
1000
maxNumSgtToAci
Integer
No
Max number of SGTs
500
-
get_aci_settings
(headers=None, **query_parameters)[source]¶ This API allows the client to get ACI Settings.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(headers=None, **query_parameters)[source]¶ Alias for get_aci_settings
-
test_aci_connectivity
(headers=None, **query_parameters)[source]¶ This API allows the client to test ACI Domain Manager connection.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_aci_settings_by_id
(id, aci50=None, aci51=None, aciipaddress=None, acipassword=None, aciuser_name=None, admin_name=None, admin_password=None, all_sxp_domain=None, default_sgt_name=None, enable_aci=None, enable_data_plane=None, enable_elements_limit=None, ip_address_host_name=None, l3_route_network=None, max_num_iepg_from_aci=None, max_num_sgt_to_aci=None, specific_sxp_domain=None, specifix_sxp_domain_list=None, suffix_to_epg=None, suffix_to_sgt=None, tenant_name=None, untagged_packet_iepg_name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update ACI settings.
- Parameters
aci50 (boolean) – Enable 5.0 ACI Version, property of the request body.
aci51 (boolean) – Enable 5.1 ACI Version, property of the request body.
aciipaddress (string) – ACI Domain manager Ip Address., property of the request body.
acipassword (string) – ACI Domain manager Password., property of the request body.
aciuser_name (string) – ACI Domain manager Username., property of the request body.
admin_name (string) – ACI Cluster Admin name, property of the request body.
admin_password (string) – ACI Cluster Admin password, property of the request body.
all_sxp_domain (boolean) – allSxpDomain, property of the request body.
default_sgt_name (string) – defaultSgtName, property of the request body.
enable_aci (boolean) – Enable ACI Integration, property of the request body.
enable_data_plane (boolean) – enableDataPlane, property of the request body.
enable_elements_limit (boolean) – enableElementsLimit, property of the request body.
id (basestring) – Resource UUID value, property of the request body.
ip_address_host_name (string) – ACI Cluster IP Address / Host name, property of the request body.
l3_route_network (string) – l3RouteNetwork, property of the request body.
max_num_iepg_from_aci (integer) – maxNumIepgFromAci, property of the request body.
max_num_sgt_to_aci (integer) – maxNumSgtToAci, property of the request body.
specific_sxp_domain (boolean) – specificSxpDomain, property of the request body.
specifix_sxp_domain_list (list) – specifixSxpDomainList, property of the request body (list of strings).
suffix_to_epg (string) – suffixToEpg, property of the request body.
suffix_to_sgt (string) – suffixToSgt, property of the request body.
tenant_name (string) – tenantName, property of the request body.
untagged_packet_iepg_name (string) – untaggedPacketIepgName, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, aci50=None, aci51=None, aciipaddress=None, acipassword=None, aciuser_name=None, admin_name=None, admin_password=None, all_sxp_domain=None, default_sgt_name=None, enable_aci=None, enable_data_plane=None, enable_elements_limit=None, ip_address_host_name=None, l3_route_network=None, max_num_iepg_from_aci=None, max_num_sgt_to_aci=None, specific_sxp_domain=None, specifix_sxp_domain_list=None, suffix_to_epg=None, suffix_to_sgt=None, tenant_name=None, untagged_packet_iepg_name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_aci_settings_by_id
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the Cisco ACI settings.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
anc_endpoint¶
-
class
AncEndpoint
[source]¶ Identity Services Engine ANCEndpoint API (version: 3.1.0).
Wraps the Identity Services Engine ANCEndpoint API and exposes the API as native Python methods that return native Python objects.
Adaptive Network Control (ANC) provides the ability to create network endpoint authorization controls based on ANC policies.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.1
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Example Values
name
String
Yes
Resource Name
id
String
No
Resource UUID
f9269682-dcaf-11e3-ad0a-5bdcd2d9fd69
description
String
No
macAddress
String
Yes
MAC address of the endpoint
00:11:22:33:44:55
policyName
String
Yes
Policy name to be applied to the endpoint
policy1
Supported ANC API transactions per second
On a 5 node Cisco ISE deployment with 60k sessions or on a 9 node Cisco ISE deployment with 200k/500k sessions, 250 transactions per second (TPS) is supported for any ANC API.Supported ANC APIs* applyEndpointByMacAddress * clearEndpointByMacaddress * applyEndpointByIpAddress * applyEndpointPolicy * clearEndpointPolicyDeployment
Number of Sessions
Supported ANC APIs TPS
5 nodes
60k
250
9 nodes
200k
250
5 nodes
500k
250
-
get_anc_endpoint_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get an ANC endpoint by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_anc_endpoint_by_id
-
clear_anc_endpoint
(additional_data=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to clear the required configuration.
- Parameters
additional_data (list) – additionalData, property of the request body (list of objects).
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
clear
(additional_data=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for clear_anc_endpoint
-
get_anc_endpoint
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the ANC endpoints. Filter: [name] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_anc_endpoint
-
get_anc_endpoint_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the ANC endpoints. Filter: [name] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_anc_endpoint_generator
-
apply_anc_endpoint
(additional_data=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to apply the required configuration.
- Parameters
additional_data (list) – additionalData, property of the request body (list of objects).
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
apply
(additional_data=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for apply_anc_endpoint
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the ANC Endpoint.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
bulk_request_for_anc_endpoint
(operation_type=None, resource_media_type=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to submit the bulk request.
- Parameters
operation_type (string) – operationType, property of the request body.
resource_media_type (string) – resourceMediaType, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
bulk_request
(operation_type=None, resource_media_type=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for bulk_request_for_anc_endpoint
-
monitor_bulk_status_anc_endpoint
(bulkid, headers=None, **query_parameters)[source]¶ This API allows the client to monitor the bulk request.
- Parameters
bulkid (basestring) – bulkid path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
monitor_bulk_status
(bulkid, headers=None, **query_parameters)[source]¶ Alias for monitor_bulk_status_anc_endpoint
-
active_directory¶
-
class
ActiveDirectory
[source]¶ Identity Services Engine ActiveDirectory API (version: 3.1.0).
Wraps the Identity Services Engine ActiveDirectory API and exposes the API as native Python methods that return native Python objects.
The Active Directory API allows the user to carry out add, delete, and search operations on the active directory domains through Cisco ISE’s join points. For example, if you want to connect to the domain cisco.com and retrieve the domain groups, you can carry out the following steps which are also available as APIs: Step 1 Create a domain join point in Cisco ISE. In the “domain” parameter use cisco.com.Step 2 Get all defined join points and copy your join point’s ID from the response.Step 3 Join all Cisco ISE nodes to the domain. Use the ID received in the Step 2 in the URL. From this point onwards, you can perform several actions. In each action you should specify the joint point ID in the URL, as retrieved in step 2 in the previous configuration task. For example, you can: • Retrieve the user groups using the join point ID.• Retrieve the groups of a specific domain using the join point ID. The domain parameter can be cisco.com or any of its trusted domains. You can use the get all trusted domains operation to retrieve the list.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
Revision Modification
Revision Modification
Attribute
Description
0
1.0
2.2
Initial Cisco ISE Version
1
1.1
2.4
Support new attributes
advancedSettings
Added ERSActiveDirectoryAdvancedSettings Attribute ‘advancedSettings’
adAttributes
Added ERSActiveDirectoryAttributes Attribute ‘adAttributes’
enableDomainWhiteList
Added Boolean Attribute ‘enableDomainWhiteList’
2
1.2
3.1
Support new attributes under ActiveDirectory AdvancedSettings
enableFailedAuthProtection
Added Boolean Attribute ‘enableFailedAuthProtection’
failedAuthThreshold
Added Integer Attribute ‘failedAuthThreshold’
authProtectionType
Added Enum Attribute ‘authProtectionType’
Resource Definition
Attribute
Type
Required
Description
Default Values
Example Values
name
String
Yes
Resource Name. Maximum 32 characters allowed. Allowed characters are alphanumeric and .-_/ characters
…
Company_users
id
String
No
Resource UUID value
…
af1cd190-7d71-11eb-b02e-ead13cf60dcb
description
String
No
No character restriction
…
Group of Active company users
domain
String
Yes
The AD domain. Alphanumeric, hyphen (-) and dot (.) characters are allowed
…
cisco.com
adScopesNames
String
No
String that contains the names of the scopes that the active directory belongs to. Names are separated by comma. Alphanumeric, underscore (_) characters are allowed
Default_Scope
…
enableDomainWhiteList
Boolean
No
…
true
…
adGroups
List
No
Holds list of AD Groups
…
…
groups
List
No
List of Groups
…
…
name
String
Yes
Required for each group in the group list with no duplication between groups. All characters are allowed except %
…
cisco.com/operators
sid
String
Yes
Cisco ISE uses security identifiers (SIDs) for optimization of group membership evaluation. SIDs are useful for efficiency (speed) when the groups are evaluated. All characters are allowed except %
…
S-1-5-32-548
type
String
No
No character restriction
…
GLOBAL
adAttributes
List
No
Holds list of AD Attributes
…
…
attributes
List
No
List of Attributes
…
…
name
String
Yes
Required for each attribute in the attribute list with no duplication between attributes. All characters are allowed except <%”
…
name1
type
Enum
Yes
Required for each group in the group list. Allowed values: - STRING, - IP, - BOOLEAN, - INT, - OCTET_STRING
STRING
…
internalName
String
Yes
Required for each attribute in the attribute list. All characters are allowed except <%”
…
internalName1
defaultValue
String
Yes
Required for each attribute in the attribute list. Can contain an empty string. All characters are allowed except <%”
…
defaultString
advancedSettings
List
No
…
…
…
rewriteRules
List
No
Identity rewrite is an advanced feature that directs Cisco ISE to manipulate the identity before it is passed to the external Active Directory system. You can create rules to change the identity to a desired format that includes or excludes a domain prefix and/or suffix or other additional markup of your choice
…
…
rowId
Integer
Yes
Required for each rule in the list in serial order
…
0
rewriteMatch
String
Yes
Required for each rule in the list with no duplication between rules. All characters are allowed except %”
…
exampleMatch0
rewriteResult
String
Yes
Required for each rule in the list. All characters are allowed except %”
…
exampleResult0
enableRewrites
Boolean
No
…
false
…
enablePassChange
Boolean
No
…
true
…
enableMachineAuth
Boolean
No
…
true
…
enableMachineAccess
Boolean
No
…
true
…
enableDialinPermissionCheck
Boolean
No
…
false
…
plaintextAuth
Boolean
No
…
false
…
agingTime
Integer
No
Range 1-8760 hours
5
…
enableCallbackForDialinClient
Boolean
No
…
false
…
identityNotInAdBehaviour
Enum
No
Allowed values: - REJECT, - SEARCH_JOINED_FOREST, - SEARCH_ALL
SEARCH_JOINED_FOREST
…
unreachableDomainsBehaviour
Enum
No
Allowed values: - PROCEED, - DROP
PROCEED
…
schema
Enum
No
Allowed values: - ACTIVE_DIRECTORY, - CUSTOMChoose ACTIVE_DIRECTORY schema when the AD attributes defined in AD can be copied to relevant attributes in Cisco ISE. If customization is needed, choose CUSTOM schema. All User info attributes are always set to default value if schema is ACTIVE_DIRECTORY. Values can be changed only for CUSTOM schema
ACTIVE_DIRECTORY
…
firstName
String
No
User info attribute. All characters are allowed except %
givenName
…
department
String
No
User info attribute. All characters are allowed except %
department
…
lastName
String
No
User info attribute. All characters are allowed except %
sn
…
organizationalUnit
String
No
User info attribute. All characters are allowed except %
company
…
jobTitle
String
No
User info attribute. All characters are allowed except %
title
…
locality
String
No
User info attribute. All characters are allowed except %
l
…
email
String
No
User info attribute. All characters are allowed except %
mail
…
stateOrProvince
String
No
User info attribute. All characters are allowed except %
st
…
telephone
String
No
User info attribute. All characters are allowed except %
telephoneNumber
…
country
String
No
User info attribute. All characters are allowed except %
co
…
streetAddress
String
No
User info attribute. All characters are allowed except %
streetAddress
…
enableFailedAuthProtection
Boolean
No
Enable prevent AD account lockout due to too many bad password attempts
false
…
failedAuthThreshold
Integer
No
Number of bad password attempts
5
…
authProtectionType
Enum
No
Enable prevent AD account lockout. Allowed values:- WIRELESS, - WIRED, - BOTH
WIRELESS
…
-
get_active_directory_by_name
(name, headers=None, **query_parameters)[source]¶ This API allows the client to get Active Directory by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_name
(name, headers=None, **query_parameters)[source]¶ Alias for get_active_directory_by_name
-
get_user_groups
(id, additional_data=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to get groups of which a given user is a member.
- Parameters
additional_data (list) – additionalData, property of the request body (list of objects).
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
load_groups_from_domain
(id, ad_attributes=None, ad_scopes_names=None, adgroups=None, advanced_settings=None, description=None, domain=None, enable_domain_white_list=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API loads domain groups configuration from Active Directory into Cisco ISE.
- Parameters
ad_attributes (object) – Holds list of AD Attributes, property of the request body.
ad_scopes_names (string) – String that contains the names of the scopes that the active directory belongs to. Names are separated by comma. Alphanumeric, underscore (_) characters are allowed, property of the request body.
adgroups (object) – Holds list of AD Groups, property of the request body.
advanced_settings (object) – advancedSettings, property of the request body.
description (string) – No character restriction, property of the request body.
domain (string) – The AD domain. Alphanumeric, hyphen (-) and dot (.) characters are allowed, property of the request body.
enable_domain_white_list (boolean) – enableDomainWhiteList, property of the request body.
id (basestring) – Resource UUID value, property of the request body.
name (string) – Resource Name. Maximum 32 characters allowed. Allowed characters are alphanumeric and .-_/characters, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
leave_domain
(id, additional_data=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API makes a Cisco ISE node to leave an Active Directory domain.
- Parameters
additional_data (list) – additionalData, property of the request body (list of objects).
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
is_user_member_of_groups
(id, additional_data=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API verifies if the user is a member of the given groups.
- Parameters
additional_data (list) – additionalData, property of the request body (list of objects).
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_trusted_domains
(id, headers=None, **query_parameters)[source]¶ This API gets the list of domains that are accessible through the given join point via trust relationships.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
join_domain_with_all_nodes
(id, additional_data=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API joins all Cisco ISE Nodes to an Active Directory domain.
- Parameters
additional_data (list) – additionalData, property of the request body (list of objects).
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
leave_domain_with_all_nodes
(id, additional_data=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API joins makes all Cisco ISE nodes leave an Active Directory domain.
- Parameters
additional_data (list) – additionalData, property of the request body (list of objects).
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_groups_by_domain
(id, additional_data=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API lists the groups of the given domain.
- Parameters
additional_data (list) – additionalData, property of the request body (list of objects).
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_active_directory_by_id
(id, headers=None, **query_parameters)[source]¶ This API fetchs the join point details by ID. The ID can be retrieved with the Get All operation.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_active_directory_by_id
-
delete_active_directory_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes an AD join point from Cisco ISE.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_active_directory_by_id
-
join_domain
(id, additional_data=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API joins a Cisco ISE node to an Active Directory domain.
- Parameters
additional_data (list) – additionalData, property of the request body (list of objects).
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_active_directory
(page=None, size=None, headers=None, **query_parameters)[source]¶ This API lists all the join points for Active Directory domains in Cisco ISE.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_active_directory
-
get_active_directory_generator
(page=None, size=None, headers=None, **query_parameters)[source]¶ This API lists all the join points for Active Directory domains in Cisco ISE.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_active_directory_generator
-
create_active_directory
(ad_attributes=None, ad_scopes_names=None, adgroups=None, advanced_settings=None, description=None, domain=None, enable_domain_white_list=None, id=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates an AD join point in Cisco ISE.
- Parameters
ad_attributes (object) – Holds list of AD Attributes, property of the request body.
ad_scopes_names (string) – String that contains the names of the scopes that the active directory belongs to. Names are separated by comma. Alphanumeric, underscore (_) characters are allowed, property of the request body.
adgroups (object) – Holds list of AD Groups, property of the request body.
advanced_settings (object) – advancedSettings, property of the request body.
description (string) – No character restriction, property of the request body.
domain (string) – The AD domain. Alphanumeric, hyphen (-) and dot (.) characters are allowed, property of the request body.
enable_domain_white_list (boolean) – enableDomainWhiteList, property of the request body.
id (string) – Resource UUID value, property of the request body.
name (string) – Resource Name. Maximum 32 characters allowed. Allowed characters are alphanumeric and .-_/characters, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(ad_attributes=None, ad_scopes_names=None, adgroups=None, advanced_settings=None, description=None, domain=None, enable_domain_white_list=None, id=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_active_directory
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the active directory.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
admin_user¶
-
class
AdminUser
[source]¶ Identity Services Engine AdminUser API (version: 3.1.0).
Wraps the Identity Services Engine AdminUser API and exposes the API as native Python methods that return native Python objects.
The Admin User API allows to retrieve information related to admin users configured on Cisco ISE.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
1.2
Initial Cisco ISE Version
1
1.1
2.0
Cisco ISE Release 2.3 Admin User
Resource Definition
Attribute
Type
Required
Description
Example Values
Default Value
name
String
Yes
Resource Name
id
String
Yes
Resource UUID
f9269682-dcaf-11e3-ad0a-5bdcd2d9fd69
description
String
No
changePassword
Boolean
Yes
true
true
email
String
No
includeSystemAlarmsInEmail
Boolean
No
false
inactiveAccountNeverDisabled
Boolean
No
true
enabled
Boolean
Yes
false
external
Boolean
No
true
customAttributes
String
No
Key Value Map
{“MyCustomAttribute” : “Value1”}
firstName
String
No
adminGroups
String
No
Admin Group Names
Super Admin
lastName
String
No
password
String
No
The password field doesn’t show the actual password configured. It is hidden with the asterisk (*) symbol
-
get_admin_user_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get an admin user by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_admin_user_by_id
-
get_admin_users
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the admin users. Filter: [firstName, lastName, adminGroups, name, description, inactiveAccountNeverDisabled, includeSystemAlarmsInEmail, email, enabled] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_admin_users
-
get_admin_users_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the admin users. Filter: [firstName, lastName, adminGroups, name, description, inactiveAccountNeverDisabled, includeSystemAlarmsInEmail, email, enabled] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_admin_users_generator
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the admin user.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
allowed_protocols¶
-
class
AllowedProtocols
[source]¶ Identity Services Engine AllowedProtocols API (version: 3.1.0).
Wraps the Identity Services Engine AllowedProtocols API and exposes the API as native Python methods that return native Python objects.
Allowed Protocols API allows the client to add, delete, update, search and perform actions on allowed protocols.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
Revision Modification
Revision Modification
Attribute
Description
0
1.0
2.3
Initial Cisco ISE Version
1
1.1
2.7
Added support for TEAP
preferredEapProtocol
Added value ‘TEAP’ to enum attribute preferredEapProtocol
allowTeap
Added boolean attribute allowTeap
allowTeapEapMsChapV2
Added boolean attribute allowTeapEapMsChapV2
allowTeapEapMsChapV2PwdChange
Added boolean attribute allowTeap
allowTeapEapMsChapV2PwdChangeRetries
Added int attribute allowTeapEapMsChapV2PwdChangeRetries
allowTeapEapTls
Added boolean attribute allowTeapEapTls
Resource Definition
Attribute
Type
Required
Description
Example Values
name
String
Yes
Resource Name
Default Device Admin
id
String
No
Resource UUID, Mandatory for update
926901b0-8c01-11e6-996c-525400b48521
description
String
No
Default Allowed Protocol Service Device Admin
processHostLookup
Boolean
Yes
true
allowPapAscii
Boolean
No
true
allowChap
Boolean
Yes
false
allowMsChapV1
Boolean
Yes
false
allowMsChapV2
Boolean
Yes
false
allowEapMd5
Boolean
Yes
true
allowLeap
Boolean
Yes
false
allowEapTls
Boolean
Yes
true
allowEapTtls
Boolean
Yes
true
allowEapFast
Boolean
Yes
true
allowPeap
Boolean
Yes
true
allowTeap
Boolean
Yes
true
allowPreferredEapProtocol
Boolean
Yes
true
eapTlsLBit
Boolean
Yes
false
allowWeakCiphersForEap
Boolean
Yes
false
requireMessageAuth
Boolean
Yes
false
preferredEapProtocol
Enum
No
The preferredEapProtocol is required only if allowPreferredEapProtocol is true, otherwise it must be ignored.
PEAP
eapTls
List
No
The eapTls is required only if allowEapTls is true, otherwise it must be ignored. The object eapTls contains the settings for EAP TLS protocol
allowEapTlsAuthOfExpiredCerts
Boolean
Yes
false
eapTlsEnableStatelessSessionResume
Boolean
Yes
false
eapTlsSessionTicketTtl
Integer
No
Time to live. The eapTlsSessionTicketTtl is required only if eapTlsEnableStatelessSessionResume is true, otherwise it must be ignored
1
eapTlsSessionTicketTtlUnits
Enum
No
Time to live time units. The eapTlsSessionTicketTtlUnits is required only if eapTlsEnableStatelessSessionResume is true, otherwise it must be ignored.
SECONDS
eapTlsSessionTicketPrecentage
Integer
No
The eapTlsSessionTicketPrecentage is required only if eapTlsEnableStatelessSessionResume is true, otherwise it must be ignored
1
peap
List
No
The peap is required only if allowPeap is true, otherwise it must be ignored. The object peap contains the settings for PEAP protocol
allowPeapEapMsChapV2
Boolean
Yes
true
allowPeapEapMsChapV2PwdChange
Boolean
No
The allowPeapEapMsChapV2PwdChange is required only if allowPeapEapMsChapV2 is true, otherwise it must be ignored
true
allowPeapEapMsChapV2PwdChangeRetries
Integer
No
The allowPeapEapMsChapV2PwdChangeRetries is required only if allowPeapEapMsChapV2 is true, otherwise it must be ignored. Valid range is 0-3
1
allowPeapEapGtc
Boolean
Yes
false
allowPeapEapGtcPwdChange
Boolean
No
The allowPeapEapGtcPwdChange is required only if allowPeapEapGtc is true, otherwise it must be ignored
false
allowPeapEapGtcPwdChangeRetries
Integer
No
The allowPeapEapGtcPwdChangeRetries is required only if allowPeapEapGtc is true, otherwise it must be ignored. Valid range is 0-3
1
allowPeapEapTls
Boolean
Yes
true
allowPeapEapTlsAuthOfExpiredCerts
Boolean
No
The allowPeapEapTlsAuthOfExpiredCerts is required only if allowPeapEapTls is true, otherwise it must be ignored
false
requireCryptobinding
Boolean
Yes
false
allowPeapV0
Boolean
Yes
false
eapTtls
List
No
The eapTtls is required only if allowEapTtls is true, otherwise it must be ignored. The object eapTtls contains the settings for EAP TTLS protocol
eapTtlsPapAscii
Boolean
Yes
true
eapTtlsChap
Boolean
Yes
true
eapTtlsMsChapV1
Boolean
Yes
true
eapTtlsMsChapV2
Boolean
Yes
true
eapTtlsEapMd5
Boolean
Yes
true
eapTtlsEapMsChapV2
Boolean
Yes
true
eapTtlsEapMsChapV2PwdChange
Boolean
No
The eapTtlsEapMsChapV2PwdChange is required only if eapTtlsEapMsChapV2 is true, otherwise it must be ignored
true
eapTtlsEapMsChapV2PwdChangeRetries
Integer
No
The eapTtlsEapMsChapV2PwdChangeRetries is required only if eapTtlsEapMsChapV2 is true, otherwise it must be ignored. Valid range is 0-3
1
eapFast
List
No
The eapFast is required only if allowEapFast is true, otherwise it must be ignored. The object eapFast contains the settings for EAP FAST protocol
allowEapFastEapMsChapV2
Boolean
Yes
true
allowEapFastEapMsChapV2PwdChange
Boolean
No
The allowEapFastEapMsChapV2PwdChange is required only if allowEapFastEapMsChapV2 is true, otherwise it must be ignored
true
allowEapFastEapMsChapV2PwdChangeRetries
Integer
No
The allowEapFastEapMsChapV2PwdChangeRetries is required only if eapTtlsEapMsChapV2 is true, otherwise it must be ignored. Valid range is 0-3
1
allowEapFastEapGtc
Boolean
Yes
true
allowEapFastEapGtcPwdChange
Boolean
No
The allowEapFastEapGtcPwdChange is required only if allowEapFastEapGtc is true, otherwise it must be ignored
true
allowEapFastEapGtcPwdChangeRetries
Integer
No
The allowEapFastEapGtcPwdChangeRetries is required only if allowEapFastEapGtc is true, otherwise it must be ignored. Valid range is 0-3
1
allowEapFastEapTls
Boolean
Yes
true
allowEapFastEapTlsAuthOfExpiredCerts
Boolean
No
The allowEapFastEapTlsAuthOfExpiredCerts is required only if allowEapFastEapTls is true, otherwise it must be ignored
false
eapFastEnableEAPChaining
Boolean
Yes
false
eapFastUsePacs
Boolean
Yes
true
eapFastUsePacsTunnelPacTtl
Integer
No
The eapFastUsePacsTunnelPacTtl is required only if eapFastUsePacs is true, otherwise it must be ignored
7776000
eapFastUsePacsTunnelPacTtlUnits
Enum
No
The eapFastUsePacsTunnelPacTtlUnits is required only if eapFastUsePacs is true, otherwise it must be ignored.
SECONDS
eapFastUsePacsUseProactivePacUpdatePrecentage
Integer
No
The eapFastUsePacsUseProactivePacUpdatePrecentage is required only if eapFastUsePacs is true, otherwise it must be ignored
10
eapFastUsePacsAllowAnonymProvisioning
Boolean
No
The eapFastUsePacsAllowAnonymProvisioning is required only if eapFastUsePacs is true, otherwise it must be ignored
false
eapFastUsePacsAllowAuthenProvisioning
Boolean
No
The eapFastUsePacsAllowAuthenProvisioning is required only if eapFastUsePacs is true, otherwise it must be ignored
false
eapFastUsePacsReturnAccessAccept
AfterAuthenticatedProvisioning
Boolean
No
The eapFastUsePacsReturnAccessAcceptAfterAuthenticatedProvisioning is required only if eapFastUsePacsAllowAuthenProvisioning is true, otherwise it must be ignored
false
eapFastUsePacsAcceptClientCert
Boolean
No
The eapFastUsePacsAcceptClientCert is required only if eapFastUsePacsAllowAuthenProvisioning is true, otherwise it must be ignored
false
eapFastUsePacsAllowMachineAuthentication
Boolean
No
false
eapFastUsePacsMachinePacTtl
Integer
No
The eapFastUsePacsMachinePacTtl is required only if eapFastUsePacsAllowMachineAuthentication is true, otherwise it must be ignored
1
eapFastUsePacsMachinePacTtlUnits
Enum
No
The eapFastUsePacsMachinePacTtlUnits is required only if eapFastUsePacsAllowMachineAuthentication is true, otherwise it must be ignored.
SECONDS
eapFastUsePacsStatelessSessionResume
Boolean
No
The eapFastUsePacsStatelessSessionResume is required only if eapFastUsePacs is true, otherwise it must be ignored
false
eapFastUsePacsAuthorizationPacTtl
Integer
No
The eapFastUsePacsAuthorizationPacTtl is required only if eapFastUsePacsStatelessSessionResume is true, otherwise it must be ignored
1
eapFastUsePacsAuthorizationPacTtlUnits
Enum
No
The eapFastUsePacsAuthorizationPacTtlUnits is required only if eapFastUsePacsStatelessSessionResume is true, otherwise it must be ignored.
SECONDS
eapFastDontUsePacsAcceptClientCert
Boolean
No
The eapFastDontUsePacsAcceptClientCert is required only if eapFastUsePacs is FALSE, otherwise it must be ignored
false
eapFastDontUsePacsAllowMachineAuthentication
Boolean
No
The eapFastDontUsePacsAllowMachineAuthentication is required only if eapFastUsePacs is FALSE, otherwise it must be ignored
false
teap
List
No
The teap is required only if allowTeap is true, otherwise it must be ignored. The object teap contains the settings for TEAP protocol
allowTeapEapMsChapV2
Boolean
Yes
true
allowTeapEapMsChapV2PwdChange
Boolean
No
The allowTeapEapMsChapV2PwdChange is required only if allowTeapEapMsChapV2 is true, otherwise it must be ignored
true
allowTeapEapMsChapV2PwdChangeRetries
Integer
No
The allowTeapEapMsChapV2PwdChangeRetries is required only if allowTeapEapMsChapV2 is true, otherwise it must be ignored. Valid range is 0-3
3
allowTeapEapTls
Boolean
Yes
true
allowTeapEapTlsAuthOfExpiredCerts
Boolean
No
The allowTeapEapTlsAuthOfExpiredCerts is required only if allowTeapEapTls is true, otherwise it must be ignored
false
acceptClientCertDuringTunnelEst
Boolean
Yes
true
enableEapChaining
Boolean
Yes
false
allowDowngradeMsk
Boolean
Yes
false
-
get_allowed_protocol_by_name
(name, headers=None, **query_parameters)[source]¶ This API allows the client to get an allowed protocol by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_name
(name, headers=None, **query_parameters)[source]¶ Alias for get_allowed_protocol_by_name
-
get_allowed_protocol_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get an allowed protocol by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_allowed_protocol_by_id
-
update_allowed_protocol_by_id
(id, allow_chap=None, allow_eap_fast=None, allow_eap_md5=None, allow_eap_tls=None, allow_eap_ttls=None, allow_leap=None, allow_ms_chap_v1=None, allow_ms_chap_v2=None, allow_pap_ascii=None, allow_peap=None, allow_preferred_eap_protocol=None, allow_teap=None, allow_weak_ciphers_for_eap=None, description=None, eap_fast=None, eap_tls=None, eap_tls_l_bit=None, eap_ttls=None, name=None, peap=None, preferred_eap_protocol=None, process_host_lookup=None, require_message_auth=None, teap=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update an allowed protocol.
- Parameters
allow_chap (boolean) – allowChap, property of the request body.
allow_eap_fast (boolean) – allowEapFast, property of the request body.
allow_eap_md5 (boolean) – allowEapMd5, property of the request body.
allow_eap_tls (boolean) – allowEapTls, property of the request body.
allow_eap_ttls (boolean) – allowEapTtls, property of the request body.
allow_leap (boolean) – allowLeap, property of the request body.
allow_ms_chap_v1 (boolean) – allowMsChapV1, property of the request body.
allow_ms_chap_v2 (boolean) – allowMsChapV2, property of the request body.
allow_pap_ascii (boolean) – allowPapAscii, property of the request body.
allow_peap (boolean) – allowPeap, property of the request body.
allow_preferred_eap_protocol (boolean) – allowPreferredEapProtocol, property of the request body.
allow_teap (boolean) – allowTeap, property of the request body.
allow_weak_ciphers_for_eap (boolean) – allowWeakCiphersForEap, property of the request body.
description (string) – description, property of the request body.
eap_fast (object) – The eapFast is required only if allowEapFast is true, otherwise it must be ignored. The object eapFast contains the settings for EAP FAST protocol, property of the request body.
eap_tls (object) – The eapTls is required only if allowEapTls is true, otherwise it must be ignored. The object eapTls contains the settings for EAP TLS protocol, property of the request body.
eap_tls_l_bit (boolean) – eapTlsLBit, property of the request body.
eap_ttls (object) – The eapTtls is required only if allowEapTtls is true, otherwise it must be ignored. The object eapTtls contains the settings for EAP TTLS protocol, property of the request body.
id (basestring) – Resource UUID, Mandatory for update, property of the request body.
name (string) – Resource Name, property of the request body.
peap (object) – peap, property of the request body.
preferred_eap_protocol (string) – The preferredEapProtocol is required only if allowPreferredEapProtocol is true, otherwise it must be ignored. Allowed Values: EAP_FAST, PEAP, LEAP, EAP_MD5, EAP_TLS, EAP_TTLS, TEAP, property of the request body.
process_host_lookup (boolean) – processHostLookup, property of the request body.
require_message_auth (boolean) – requireMessageAuth, property of the request body.
teap (object) – The teap is required only if allowTeap is true, otherwise it must be ignored. The object teap contains the settings for TEAP protocol, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, allow_chap=None, allow_eap_fast=None, allow_eap_md5=None, allow_eap_tls=None, allow_eap_ttls=None, allow_leap=None, allow_ms_chap_v1=None, allow_ms_chap_v2=None, allow_pap_ascii=None, allow_peap=None, allow_preferred_eap_protocol=None, allow_teap=None, allow_weak_ciphers_for_eap=None, description=None, eap_fast=None, eap_tls=None, eap_tls_l_bit=None, eap_ttls=None, name=None, peap=None, preferred_eap_protocol=None, process_host_lookup=None, require_message_auth=None, teap=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_allowed_protocol_by_id
-
delete_allowed_protocol_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes an allowed protocol.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_allowed_protocol_by_id
-
get_allowed_protocols
(page=None, size=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the allowed protocols.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_allowed_protocols
-
get_allowed_protocols_generator
(page=None, size=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the allowed protocols.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_allowed_protocols_generator
-
create_allowed_protocol
(allow_chap=None, allow_eap_fast=None, allow_eap_md5=None, allow_eap_tls=None, allow_eap_ttls=None, allow_leap=None, allow_ms_chap_v1=None, allow_ms_chap_v2=None, allow_pap_ascii=None, allow_peap=None, allow_preferred_eap_protocol=None, allow_teap=None, allow_weak_ciphers_for_eap=None, description=None, eap_fast=None, eap_tls=None, eap_tls_l_bit=None, eap_ttls=None, name=None, peap=None, preferred_eap_protocol=None, process_host_lookup=None, require_message_auth=None, teap=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates an allowed protocol.
- Parameters
allow_chap (boolean) – allowChap, property of the request body.
allow_eap_fast (boolean) – allowEapFast, property of the request body.
allow_eap_md5 (boolean) – allowEapMd5, property of the request body.
allow_eap_tls (boolean) – allowEapTls, property of the request body.
allow_eap_ttls (boolean) – allowEapTtls, property of the request body.
allow_leap (boolean) – allowLeap, property of the request body.
allow_ms_chap_v1 (boolean) – allowMsChapV1, property of the request body.
allow_ms_chap_v2 (boolean) – allowMsChapV2, property of the request body.
allow_pap_ascii (boolean) – allowPapAscii, property of the request body.
allow_peap (boolean) – allowPeap, property of the request body.
allow_preferred_eap_protocol (boolean) – allowPreferredEapProtocol, property of the request body.
allow_teap (boolean) – allowTeap, property of the request body.
allow_weak_ciphers_for_eap (boolean) – allowWeakCiphersForEap, property of the request body.
description (string) – description, property of the request body.
eap_fast (object) – The eapFast is required only if allowEapFast is true, otherwise it must be ignored. The object eapFast contains the settings for EAP FAST protocol, property of the request body.
eap_tls (object) – The eapTls is required only if allowEapTls is true, otherwise it must be ignored. The object eapTls contains the settings for EAP TLS protocol, property of the request body.
eap_tls_l_bit (boolean) – eapTlsLBit, property of the request body.
eap_ttls (object) – The eapTtls is required only if allowEapTtls is true, otherwise it must be ignored. The object eapTtls contains the settings for EAP TTLS protocol, property of the request body.
name (string) – Resource Name, property of the request body.
peap (object) – peap, property of the request body.
preferred_eap_protocol (string) – The preferredEapProtocol is required only if allowPreferredEapProtocol is true, otherwise it must be ignored. Allowed Values: EAP_FAST, PEAP, LEAP, EAP_MD5, EAP_TLS, EAP_TTLS, TEAP, property of the request body.
process_host_lookup (boolean) – processHostLookup, property of the request body.
require_message_auth (boolean) – requireMessageAuth, property of the request body.
teap (object) – The teap is required only if allowTeap is true, otherwise it must be ignored. The object teap contains the settings for TEAP protocol, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(allow_chap=None, allow_eap_fast=None, allow_eap_md5=None, allow_eap_tls=None, allow_eap_ttls=None, allow_leap=None, allow_ms_chap_v1=None, allow_ms_chap_v2=None, allow_pap_ascii=None, allow_peap=None, allow_preferred_eap_protocol=None, allow_teap=None, allow_weak_ciphers_for_eap=None, description=None, eap_fast=None, eap_tls=None, eap_tls_l_bit=None, eap_ttls=None, name=None, peap=None, preferred_eap_protocol=None, process_host_lookup=None, require_message_auth=None, teap=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_allowed_protocol
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the allowed protocols.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
anc_policy¶
-
class
AncPolicy
[source]¶ Identity Services Engine AncPolicy API (version: 3.1.0).
Wraps the Identity Services Engine AncPolicy API and exposes the API as native Python methods that return native Python objects.
Adaptive Network Control (ANC) provides the ability to create network endpoint authorization controls based on ANC policies.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.1
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Example Values
name
String
Yes
Resource Name
id
String
No
Resource ID
test
description
String
No
action
Enum
Yes
QUARANTINE: Allows you to use Exception policies (authorization policies) to limit or deny an endpoint access to the network.
PORTBOUNCE: Resets the port on the network device to which the endpoint is connected
SHUTDOWN : Shuts down the port on the network device to which the endpoint is connected
RE_AUTHENTICATE: Re-authenticates the session from the endpoint
-
get_anc_policy_by_name
(name, headers=None, **query_parameters)[source]¶ This API allows the client to get an ANC policy by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_name
(name, headers=None, **query_parameters)[source]¶ Alias for get_anc_policy_by_name
-
get_anc_policy_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get an ANC policy by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_anc_policy_by_id
-
update_anc_policy_by_id
(id, actions=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update an ANC policy.
- Parameters
actions (list) – QUARANTINE: Allows you to use Exception policies (authorization policies) to limit or deny an endpoint access to the network. PORTBOUNCE: Resets the port on the network device to which the endpoint is connected. SHUTDOWN : Shuts down the port on the network device to which the endpoint is connected. RE_AUTHENTICATE: Re-authenticates the session from the endpoint., property of the request body (list of strings. Available values are ‘QUARANTINE’, ‘PORTBOUNCE’, ‘SHUTDOWN’ and ‘RE_AUTHENTICATE’).
id (basestring) – id, property of the request body.
name (string) – name, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, actions=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_anc_policy_by_id
-
delete_anc_policy_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to delete an ANC policy.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_anc_policy_by_id
-
get_anc_policy
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the ANC policies. Filter: [name] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_anc_policy
-
get_anc_policy_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the ANC policies. Filter: [name] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_anc_policy_generator
-
create_anc_policy
(actions=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to create an ANC policy.
- Parameters
actions (list) – QUARANTINE: Allows you to use Exception policies (authorization policies) to limit or deny an endpoint access to the network. PORTBOUNCE: Resets the port on the network device to which the endpoint is connected. SHUTDOWN : Shuts down the port on the network device to which the endpoint is connected. RE_AUTHENTICATE: Re-authenticates the session from the endpoint., property of the request body (list of strings. Available values are ‘QUARANTINE’, ‘PORTBOUNCE’, ‘SHUTDOWN’ and ‘RE_AUTHENTICATE’).
name (string) – name, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(actions=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_anc_policy
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the ANC policy.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
bulk_request_for_anc_policy
(operation_type=None, resource_media_type=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to submit the bulk request.
- Parameters
operation_type (string) – operationType, property of the request body.
resource_media_type (string) – resourceMediaType, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
bulk_request
(operation_type=None, resource_media_type=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for bulk_request_for_anc_policy
-
monitor_bulk_status_anc_policy
(bulkid, headers=None, **query_parameters)[source]¶ This API allows the client to monitor the bulk request.
- Parameters
bulkid (basestring) – bulkid path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
monitor_bulk_status
(bulkid, headers=None, **query_parameters)[source]¶ Alias for monitor_bulk_status_anc_policy
byod_portal¶
-
class
ByodPortal
[source]¶ Identity Services Engine BYODPortal API (version: 3.1.0).
Wraps the Identity Services Engine BYODPortal API and exposes the API as native Python methods that return native Python objects.
BYOD Portal API provides the ability to Create, Read, Update, Delete and Search BYOD portals.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.2
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Default Values
Example Values
name
String
Yes
Resource Name
BYOD Portal (default)
id
String
No
Resource UUID, mandatory for update
9a9b910c-54d3-44a4-a3c3-dd007c171599
description
String
No
Default portal and user experience used when employees register a personal device on the network
portalTestUrl
String
No
URL to bring up a test page for this portal
https://{ise-ip}:8443/portal/PortalSetup.action?portal=9a9b910c-54d3-44a4-a3c3-dd007c171599
portalType
Enum
Yes
Allowed values: BYOD, HOTSPOTGUEST, MYDEVICE, SELFREGGUEST, SPONSOR, SPONSOREDGUEST
BYOD
settings
List
No
Defines all of the settings groups available for a BYOD
portalSettings
List
No
The port, interface, certificate, and other basic settings of a portal
httpsPort
Integer
Yes
The port number that the allowed interfaces will listen on. Range from 8000 to 8999
8443
allowedInterfaces
Enum
Yes
Interfaces that the portal will be reachable on. Allowed values: eth0, eth1, eth2, eth3, eth4, eth5, bond0, bond1, bond2
[ “eth0”, “bond0” ]
certificateGroupTag
String
Yes
Logical name of the x.509 server certificate that will be used for the portal
Default Portal Certificate Group
endpointIdentityGroup
String
Yes
Unique Id of the endpoint identity group where user’s devices will be added. Used only in Hotspot Portal
displayLang
Enum
No
Allowed values: USEBROWSERLOCALE, ALWAYSUSE
USEBROWSERLOCALE
fallbackLanguage
String
No
Used when displayLang = USEBROWSERLOCALE
English
alwaysUsedLanguage
String
No
Used when displayLang = ALWAYSUSE
English
byodSettings
List
No
Configuration of BYOD Device Welcome, Registration and Success steps
byodWelcomeSettings
List
No
Configuration of BYOD endpoint welcome step configuration
enableBYOD
Boolean
No
true
enableGuestAccess
Boolean
No
false
requireMDM
Boolean
No
false
includeAup
Boolean
No
true
aupDisplay
Enum
No
How the AUP should be displayed, either on page or as a link. Only valid if includeAup = true. Allowed values: ONPAGE, ASLINK
ONPAGE
requireAupAcceptance
Boolean
No
false
requireScrolling
Boolean
No
Require BYOD devices to scroll down to the bottom of the AUP, Only valid if includeAup = true
false
byodRegistrationSettings
List
No
Configuration of BYOD endpoint Registration step configuration
showDeviceID
Boolean
No
Display Device ID field during registration
true
endPointIdentityGroupId
String
No
Identity group id for which endpoint belongs
aa13bb40-8bff-11e6-996c-525400b48521
byodRegistrationSuccessSettings
List
No
Configuration of BYOD endpoint Registration Success step configuration
successRedirect
Enum
No
After an Authentication Success where should device be redirected.
AUTHSUCCESSPAGE
redirectUrl
String
No
Target URL for redirection, used when successRedirect = URL
Redirect URL
supportInfoSettings
List
No
Configuration of BYOD endpoint welcome step configuration
includeSupportInfoPage
Boolean
No
false
includeMacAddr
Boolean
No
false
includeIpAddress
Boolean
No
false
includeBrowserUserAgent
Boolean
No
false
includePolicyServer
Boolean
No
false
includeFailureCode
Boolean
No
false
emptyFieldDisplay
Enum
No
Specifies how empty fields are handled on the Support Information Page.
HIDE
defaultEmptyFieldValue
String
No
The default value displayed for an empty field Only valid when emptyFieldDisplay = DISPLAYWITHDEFAULTVALUE
customizations
List
No
Defines all of the Portal Customizations available for a BYOD
portalTheme
List
No
Defines the configuration for portal theme
id
String
No
The unique internal identifier of the portal theme
9eb421c0-8c01-11e6-996c-525400b48521
name
String
Yes
The system- or user-assigned name of the portal theme
Default Blue theme
themeData
String
No
A CSS file, represented as a Base64-encoded byte array
Base 64 encoded string of Theme CSS file
portalTweakSettings
List
No
The Tweak Settings are a customization of the Portal Theme that has been selected for the portal. When the Portal Theme selection is changed, the Tweak Settings are overwritten to match the values in the theme. The Tweak Settings can subsequently be changed by the user
bannerColor
String
No
Hex value of color
#0000FF
bannerTextColor
String
No
Banner Text color code from GUI
pageBackgroundColor
String
No
Color code from GUI
pageLabelAndTextColor
String
No
Label and Text color from GUI
language
List
No
This property is supported only for Read operation and it allows to show the customizations in English. Other languages are not supported
viewLanguage
String
No
English
globalCustomizations
List
No
Represent the portal Global customizations
bannerTitle
String
No
BYOD Portal
contactText
String
No
Contact Support
footerElement
String
No
Footer Element
mobileLogoImage
Image
No
data
String
No
Represented as base 64 encoded string of the image byte array
base 64 encoded value of image
desktopLogoImage
Image
No
data
String
No
Represented as base 64 encoded string of the image byte array
base 64 encoded value of image
bannerImage
Image
No
data
String
No
Represented as base 64 encoded string of the image byte array
base 64 encoded value of image
backgroundImage
Image
No
data
String
No
Represented as base 64 encoded string of the image byte array
base 64 encoded value of image
pageCustomizations
List
No
Represent the entire page customization as a giant dictionary
data
List
No
The Dictionary will be exposed here as key value pair
key
String
Yes
ui_contact_ip_address_label
value
String
Yes
SVAgYWRkcmVzczo=
-
get_byod_portal_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get a BYOD portal by ID.
- Parameters
id (basestring) – id path parameter. Portal id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_byod_portal_by_id
-
update_byod_portal_by_id
(id, customizations=None, description=None, name=None, portal_test_url=None, portal_type=None, settings=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update a BYOD portal by ID.
- Parameters
customizations (object) – Defines all of the Portal Customizations available for a BYOD, property of the request body.
description (string) – description, property of the request body.
id (basestring) – Resource UUID, mandatory for update, property of the request body.
name (string) – Resource Name, property of the request body.
portal_test_url (string) – URL to bring up a test page for this portal, property of the request body.
portal_type (string) – Allowed values: BYOD, HOTSPOTGUEST, MYDEVICE, SELFREGGUEST, SPONSOR, SPONSOREDGUEST, property of the request body.
settings (object) – Defines all of the settings groups available for a BYOD, property of the request body.
id – id path parameter. Portal id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, customizations=None, description=None, name=None, portal_test_url=None, portal_type=None, settings=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_byod_portal_by_id
-
delete_byod_portal_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes a BYOD portal by ID.
- Parameters
id (basestring) – id path parameter. Portal id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_byod_portal_by_id
-
get_byod_portal
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the BYOD portals. Filter: [name, description] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_byod_portal
-
get_byod_portal_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the BYOD portals. Filter: [name, description] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_byod_portal_generator
-
create_byod_portal
(customizations=None, description=None, id=None, name=None, portal_test_url=None, portal_type=None, settings=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates a BYOD portal.
- Parameters
customizations (object) – Defines all of the Portal Customizations available for a BYOD, property of the request body.
description (string) – description, property of the request body.
id (string) – Resource UUID, mandatory for update, property of the request body.
name (string) – Resource Name, property of the request body.
portal_test_url (string) – URL to bring up a test page for this portal, property of the request body.
portal_type (string) – Allowed values: BYOD, HOTSPOTGUEST, MYDEVICE, SELFREGGUEST, SPONSOR, SPONSOREDGUEST, property of the request body.
settings (object) – Defines all of the settings groups available for a BYOD, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(customizations=None, description=None, id=None, name=None, portal_test_url=None, portal_type=None, settings=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_byod_portal
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the BYOD portal.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
backup_and_restore¶
-
class
BackupAndRestore
[source]¶ Identity Services Engine Backup And Restore API (version: 3.1.0).
Wraps the Identity Services Engine Backup And Restore API and exposes the API as native Python methods that return native Python objects.
-
config_backup
(backup_encryption_key=None, backup_name=None, repository_name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Triggers on demand configuration backup on the ISE node. The API returns the task ID. Use the Task Service status API to get the status of the backup job.
- Parameters
backup_encryption_key (string) – The encyption key for the backed up file. Encryption key must satisfy the following criteria Contains at least one uppercase letter [A-Z], Contains at least one lowercase letter [a-z], Contains at least one digit [0-9], Contain only [A-Z][a-z][0-9]_#, Has at least 8 characters, Has not more than 15 characters, Must not contain ‘CcIiSsCco’, Must not begin with, property of the request body.
backup_name (string) – The backup file will get saved with this name., property of the request body.
repository_name (string) – Name of the configured repository where the generated backup file will get copied., property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
config
(backup_encryption_key=None, backup_name=None, repository_name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for config_backup
-
cancel_backup
(headers=None, **query_parameters)[source]¶ Cancels the backup job running on the node.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
cancel
(headers=None, **query_parameters)[source]¶ Alias for cancel_backup
-
get_last_config_backup_status
(headers=None, **query_parameters)[source]¶ Gives the last backup status.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_last_status
(headers=None, **query_parameters)[source]¶ Alias for get_last_config_backup_status
-
restore_config_backup
(backup_encryption_key=None, repository_name=None, restore_file=None, restore_include_adeos=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Triggers a configuration DB restore job on the ISE node. The API returns the task ID. Use the Task Service status API to get the status of the backup job.
- Parameters
backup_encryption_key (string) – The encryption key which was provided at the time of taking backup., property of the request body.
repository_name (string) – Name of the configred repository where the backup file exists., property of the request body.
restore_file (string) – Name of the backup file to be restored on ISE node., property of the request body.
restore_include_adeos (string) – Determines whether the ADE-OS configure is restored. Possible values true, false, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
restore
(backup_encryption_key=None, repository_name=None, restore_file=None, restore_include_adeos=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for restore_config_backup
-
update_scheduled_config_backup
(backup_description=None, backup_encryption_key=None, backup_name=None, end_date=None, frequency=None, month_day=None, repository_name=None, start_date=None, status=None, time=None, week_day=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Update the Schedule of the configuration backup on the ISE node as per the input parameters. This API only helps in editing the schedule.
- Parameters
backup_description (string) – Description of the backup., property of the request body.
backup_encryption_key (string) – The encyption key for the backed up file. Encryption key must satisfy the following criteria Contains at least one uppercase letter [A-Z], Contains at least one lowercase letter [a-z], Contains at least one digit [0-9], Contain only [A-Z][a-z][0-9]_#, Has at least 8 characters, Has not more than 15 characters, Must not contain ‘CcIiSsCco’, Must not begin with, property of the request body.
backup_name (string) – The backup file will get saved with this name., property of the request body.
end_date (string) – End date of the scheduled backup job. Allowed format MM/DD/YYYY. End date is not required in case of ONE_TIME frequency., property of the request body.
frequency (string) – Frequency with which the backup will get scheduled in the ISE node., property of the request body. Available values are ‘DAILY’, ‘MONTHLY’, ‘ONCE’ and ‘WEEKLY’.
month_day (string) – Day of month you want backup to be performed on when scheduled frequency is MONTHLY. Allowed values from 1 to 28., property of the request body.
repository_name (string) – Name of the configured repository where the generated backup file will get copied., property of the request body.
start_date (string) – Start date for scheduling the backup job. Allowed format MM/DD/YYYY., property of the request body.
status (string) – Enable or disable scheduled backup., property of the request body. Available values are ‘DISABLE’ and ‘ENABLE’.
time (string) – Time at which backup job get scheduled. example12:00 AM, property of the request body.
week_day (string) – Day of week you want backup to be performed on when scheduled frequency is WEEKLY, property of the request body. Available values are ‘FRI’, ‘MON’, ‘SAT’, ‘SUN’, ‘THU’, ‘TUE’ and ‘WED’.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update
(backup_description=None, backup_encryption_key=None, backup_name=None, end_date=None, frequency=None, month_day=None, repository_name=None, start_date=None, status=None, time=None, week_day=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_scheduled_config_backup
-
create_scheduled_config_backup
(backup_description=None, backup_encryption_key=None, backup_name=None, end_date=None, frequency=None, month_day=None, repository_name=None, start_date=None, status=None, time=None, week_day=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Schedules the configuration backup on the ISE node as per the input parameters. This API helps in creating the schedule for the first time.
- Parameters
backup_description (string) – Description of the backup., property of the request body.
backup_encryption_key (string) – The encyption key for the backed up file. Encryption key must satisfy the following criteria Contains at least one uppercase letter [A-Z], Contains at least one lowercase letter [a-z], Contains at least one digit [0-9], Contain only [A-Z][a-z][0-9]_#, Has at least 8 characters, Has not more than 15 characters, Must not contain ‘CcIiSsCco’, Must not begin with, property of the request body.
backup_name (string) – The backup file will get saved with this name., property of the request body.
end_date (string) – End date of the scheduled backup job. Allowed format MM/DD/YYYY. End date is not required in case of ONE_TIME frequency., property of the request body.
frequency (string) – Frequency with which the backup will get scheduled in the ISE node., property of the request body. Available values are ‘DAILY’, ‘MONTHLY’, ‘ONCE’ and ‘WEEKLY’.
month_day (string) – Day of month you want backup to be performed on when scheduled frequency is MONTHLY. Allowed values from 1 to 28., property of the request body.
repository_name (string) – Name of the configured repository where the generated backup file will get copied., property of the request body.
start_date (string) – Start date for scheduling the backup job. Allowed format MM/DD/YYYY., property of the request body.
status (string) – Enable or disable scheduled backup., property of the request body. Available values are ‘DISABLE’ and ‘ENABLE’.
time (string) – Time at which backup job get scheduled. example12:00 AM, property of the request body.
week_day (string) – Day of week you want backup to be performed on when scheduled frequency is WEEKLY, property of the request body. Available values are ‘FRI’, ‘MON’, ‘SAT’, ‘SUN’, ‘THU’, ‘TUE’ and ‘WED’.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(backup_description=None, backup_encryption_key=None, backup_name=None, end_date=None, frequency=None, month_day=None, repository_name=None, start_date=None, status=None, time=None, week_day=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_scheduled_config_backup
-
certificate_profile¶
-
class
CertificateProfile
[source]¶ Identity Services Engine CertificateProfile API (version: 3.1.0).
Wraps the Identity Services Engine CertificateProfile API and exposes the API as native Python methods that return native Python objects.
The certificate profile API allows the client to add, search and perform actions on the certificate profiles.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.4
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Default Values
Example Values
name
String
Yes
Resource Name
Certificate_Profile
id
String
No
Resource UUID
f9269682-dcaf-11e3-ad0a-5bdcd2d9fd69
description
String
No
allowedAsUserName
Boolean
No
To be set true or false
false
externalIdentityStoreName
String
No
Referred IDStore name for the Certificate Profile or [not applicable] in case no identity store is chosen
[not applicable]
[not applicable]
certificateAttributeName
ENUM
No
Attribute name of the Certificate Profile - used only when CERTIFICATE is chosen in usernameFrom. Allowed values: - SUBJECT_COMMON_NAME - SUBJECT_ALTERNATIVE_NAME - SUBJECT_SERIAL_NUMBER - SUBJECT - SUBJECT_ALTERNATIVE_NAME_OTHER_NAME - SUBJECT_ALTERNATIVE_NAME_EMAIL - SUBJECT_ALTERNATIVE_NAME_DNS. - Additional internal value ALL_SUBJECT_AND_ALTERNATIVE_NAMES is used automatically when usernameFrom=UPN
SUBJECT_COMMON_NAME
matchMode
ENUM
No
Match mode of the Certificate Profile. Allowed values: NEVER, RESOLVE_IDENTITY_AMBIGUITY, BINARY_COMPARISON
NEVER
usernameFrom
ENUM
No
The attribute in the certificate where the user name should be taken from.
CERTIFICATE
-
get_certificate_profile_by_name
(name, headers=None, **query_parameters)[source]¶ This API allows the client to get a certificate profile by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_name
(name, headers=None, **query_parameters)[source]¶ Alias for get_certificate_profile_by_name
-
get_certificate_profile_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get a certificate profile by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_certificate_profile_by_id
-
update_certificate_profile_by_id
(id, allowed_as_user_name=None, certificate_attribute_name=None, description=None, external_identity_store_name=None, match_mode=None, name=None, username_from=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update a certificate profile.
- Parameters
allowed_as_user_name (boolean) – allowedAsUserName, property of the request body.
certificate_attribute_name (string) – Attribute name of the Certificate Profile used only when CERTIFICATE is chosen in usernameFrom. Allowed values: SUBJECT_COMMON_NAME SUBJECT_ALTERNATIVE_NAME SUBJECT_SERIAL_NUMBER SUBJECT SUBJECT_ALTERNATIVE_NAME_OTHER_NAME SUBJECT_ALTERNATIVE_NAME_EMAIL SUBJECT_ALTERNATIVE_NAME_DNS. Additional internal value ALL_SUBJECT_AND_ALTERNATIVE_NAMES is used automatically when usernameFrom=UPN, property of the request body.
description (string) – description, property of the request body.
external_identity_store_name (string) – Referred IDStore name for the Certificate Profile or [not applicable] in case no identity store is chosen, property of the request body.
id (basestring) – id, property of the request body.
match_mode (string) – Match mode of the Certificate Profile. Allowed values: NEVER RESOLVE_IDENTITY_AMBIGUITY BINARY_COMPARISON, property of the request body.
name (string) – name, property of the request body.
username_from (string) – The attribute in the certificate where the user name should be taken from. Allowed values: CERTIFICATE (for a specific attribute as defined in certificateAttributeName) UPN (for using any Subject or Alternative Name Attributes in the Certificate an option only in AD), property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, allowed_as_user_name=None, certificate_attribute_name=None, description=None, external_identity_store_name=None, match_mode=None, name=None, username_from=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_certificate_profile_by_id
-
get_certificate_profile
(page=None, size=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the certificate profiles.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_certificate_profile
-
get_certificate_profile_generator
(page=None, size=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the certificate profiles.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_certificate_profile_generator
-
create_certificate_profile
(allowed_as_user_name=None, certificate_attribute_name=None, description=None, external_identity_store_name=None, id=None, match_mode=None, name=None, username_from=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to create a certificate profile.
- Parameters
allowed_as_user_name (boolean) – allowedAsUserName, property of the request body.
certificate_attribute_name (string) – Attribute name of the Certificate Profile used only when CERTIFICATE is chosen in usernameFrom. Allowed values: SUBJECT_COMMON_NAME SUBJECT_ALTERNATIVE_NAME SUBJECT_SERIAL_NUMBER SUBJECT SUBJECT_ALTERNATIVE_NAME_OTHER_NAME SUBJECT_ALTERNATIVE_NAME_EMAIL SUBJECT_ALTERNATIVE_NAME_DNS. Additional internal value ALL_SUBJECT_AND_ALTERNATIVE_NAMES is used automatically when usernameFrom=UPN, property of the request body.
description (string) – description, property of the request body.
external_identity_store_name (string) – Referred IDStore name for the Certificate Profile or [not applicable] in case no identity store is chosen, property of the request body.
id (string) – id, property of the request body.
match_mode (string) – Match mode of the Certificate Profile. Allowed values: NEVER RESOLVE_IDENTITY_AMBIGUITY BINARY_COMPARISON, property of the request body.
name (string) – name, property of the request body.
username_from (string) – The attribute in the certificate where the user name should be taken from. Allowed values: CERTIFICATE (for a specific attribute as defined in certificateAttributeName) UPN (for using any Subject or Alternative Name Attributes in the Certificate an option only in AD), property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(allowed_as_user_name=None, certificate_attribute_name=None, description=None, external_identity_store_name=None, id=None, match_mode=None, name=None, username_from=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_certificate_profile
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the certificate profile.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
certificate_template¶
-
class
CertificateTemplate
[source]¶ Identity Services Engine CertificateTemplate API (version: 3.1.0).
Wraps the Identity Services Engine CertificateTemplate API and exposes the API as native Python methods that return native Python objects.
The certificate template API provides the ability to search for certificate templates.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.2
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Example Values
name
String
Yes
Resource Name
id
String
No
Resource UUID
f9269682-dcaf-11e3-ad0a-5bdcd2d9fd69
description
String
No
raProfileName
String
Yes
RA profile for the Certificate template
ISE internal CA
keySize
Integer
No
Key Size of the Certificate Template
2048 1024
validity
Integer
No
Validity period of the Certificate Template: Valid Range 21 - 3652
730
-
get_certificate_template_by_name
(name, headers=None, **query_parameters)[source]¶ This API allows the client to get a certificate template by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_name
(name, headers=None, **query_parameters)[source]¶ Alias for get_certificate_template_by_name
-
get_certificate_template_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get a certificate template by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_certificate_template_by_id
-
get_certificate_template
(page=None, size=None, headers=None, **query_parameters)[source]¶ This API allows the client to get aall the certificate templates.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_certificate_template
-
get_certificate_template_generator
(page=None, size=None, headers=None, **query_parameters)[source]¶ This API allows the client to get aall the certificate templates.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_certificate_template_generator
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the certificate template.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
certificates¶
-
class
Certificates
[source]¶ Identity Services Engine Certificates API (version: 3.1.0).
Wraps the Identity Services Engine Certificates API and exposes the API as native Python methods that return native Python objects.
-
get_csrs
(filter=None, filter_type=None, page=None, size=None, sort=None, sort_by=None, headers=None, **query_parameters)[source]¶ This API supports Filtering, Sorting and Pagination. Filtering and Sorting supported on below mentioned attributes: friendlyName subject timeStamp Supported Date Format: yyyy-MM-dd HH:mm:ss.SSS Supported Operators: EQ, NEQ, GT and LT .
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sort (basestring) – sort query parameter. sort type asc or desc.
sort_by (basestring) – sortBy query parameter. sort column by which objects needs to be sorted.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. OPERATOR DESCRIPTION EQ Equals NEQ Not Equals GT Greater Than LT Less Then STARTSW Starts With NSTARTSW Not Starts With ENDSW Ends With NENDSW Not Ends With CONTAINS Contains NCONTAINS Not Contains .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_csrs_generator
(filter=None, filter_type=None, page=None, size=None, sort=None, sort_by=None, headers=None, **query_parameters)[source]¶ This API supports Filtering, Sorting and Pagination. Filtering and Sorting supported on below mentioned attributes: friendlyName subject timeStamp Supported Date Format: yyyy-MM-dd HH:mm:ss.SSS Supported Operators: EQ, NEQ, GT and LT .
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sort (basestring) – sort query parameter. sort type asc or desc.
sort_by (basestring) – sortBy query parameter. sort column by which objects needs to be sorted.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. OPERATOR DESCRIPTION EQ Equals NEQ Not Equals GT Greater Than LT Less Then STARTSW Starts With NSTARTSW Not Starts With ENDSW Ends With NENDSW Not Ends With CONTAINS Contains NCONTAINS Not Contains .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
generate_csr
(allow_wild_card_cert=None, certificate_policies=None, digest_type=None, hostnames=None, key_length=None, key_type=None, portal_group_tag=None, san_dir=None, san_dns=None, san_ip=None, san_uri=None, subject_city=None, subject_common_name=None, subject_country=None, subject_org=None, subject_org_unit=None, subject_state=None, used_for=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Generate a certificate signing request for Multi-Use, Admin, EAP Authentication, RADIUS DTLS, PxGrid, SAML, Portal and IMS Services. Following Parameters are present in POST request body PARAMETER DESCRIPTION EXAMPLE hostnames List of ise node hostnames for which CSRs should be generated [ise-host1, ise- host2] allowWildCardCert Allow use of WildCards in certificates false keyLength Length of the Key used for CSR generation (required) 512 keyType Type of key used for CSR generation either RSA or ECDSA(required) RSA digestType Hash algorithm used for signing CSR(required) SHA-256 usedFor Certificate Usage(required) MULTI-USE subjectCommonName Certificate common name(CN)(required) $FQDN$ subjectOrgUnit Certificate organizational unit(OU) Engineering subjectOrg Certificate organization (O) Cisco subjectCity Certificate city or locality (L) San Jose subjectState Certificate state (ST) California subjectCountry Certificate country ( C) US sanDNS Array of SAN(Subject Alternative Name) DNS entries(optional) [ise.example.com] sanIP Array of SAN IP entries(optional) [1.1.1.1] sanURI Array of SAN URI entries(optional) [https://1.1.1.1] sanDir Array of SAN DIR entries(optional) [CN=AAA,DC=COM,C=IL] portalGroupTag Portal Group Tag when using certificate for PORTAL service Default Portal Certificate Group NOTE: For allowWildCardCert to be false, the below mentioned parameter is mandatory: hostnames When Certificate is selected to be used for Portal Service, the below mentioned parameter is mandatory: portalGroupTag .
- Parameters
allow_wild_card_cert (boolean) – allowWildCardCert, property of the request body.
certificate_policies (string) – certificatePolicies, property of the request body.
digest_type (string) – digestType, property of the request body. Available values are ‘SHA-256’, ‘SHA-384’ and ‘SHA-512’.
hostnames (list) – hostnames, property of the request body (list of strings).
key_length (string) – keyLength, property of the request body. Available values are ‘1024’, ‘2048’, ‘4096’ and ‘512’.
key_type (string) – keyType, property of the request body. Available values are ‘ECDSA’ and ‘RSA’.
portal_group_tag (string) – portalGroupTag, property of the request body.
san_dns (list) – sanDNS, property of the request body (list of strings).
san_dir (list) – sanDir, property of the request body (list of strings).
san_ip (list) – sanIP, property of the request body (list of strings).
san_uri (list) – sanURI, property of the request body (list of strings).
subject_city (string) – subjectCity, property of the request body.
subject_common_name (string) – subjectCommonName, property of the request body.
subject_country (string) – subjectCountry, property of the request body.
subject_org (string) – subjectOrg, property of the request body.
subject_org_unit (string) – subjectOrgUnit, property of the request body.
subject_state (string) – subjectState, property of the request body.
used_for (string) – usedFor, property of the request body. Available values are ‘ADMIN’, ‘DTLS- AUTH’, ‘EAP-AUTH’, ‘IMS’, ‘MULTI-USE’, ‘PORTAL’, ‘PXGRID’ and ‘SAML’.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
export_csr
(hostname, id, dirpath=None, save_file=None, filename=None, headers=None, **query_parameters)[source]¶ The response of this API carries a CSR corresponding to the requested ID.
- Parameters
hostname (basestring) – hostname path parameter. The hostname to which the CSR belongs.
id (basestring) – id path parameter. The ID of the CSR to be exported.
dirpath (basestring) – Directory absolute path. Defaults to os.getcwd().
save_file (bool) – Enable or disable automatic file creation of raw response.
filename (basestring) – The filename used to save the download file.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
The DownloadResponse wrapper. Wraps the urllib3.response.HTTPResponse. For more information check the urlib3 documentation
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
DownloadFailure – If was not able to download the raw
response to a file. –
-
generate_intermediate_ca_csr
(headers=None, **query_parameters)[source]¶ CSR Generation for Intermediate Certificates.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_csr_by_id
(host_name, id, headers=None, **query_parameters)[source]¶ This API displays details of a Certificate Signing Request of a particular node based on a given HostName and ID.
- Parameters
host_name (basestring) – hostName path parameter. Name of the host of which CSR’s should be returned.
id (basestring) – id path parameter. The ID of the Certificate Signing Request returned.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_csr_by_id
(host_name, id, headers=None, **query_parameters)[source]¶ This API deletes a Certificate Signing Request of a particular node based on a given HostName and ID.
- Parameters
host_name (basestring) – hostName path parameter. Name of the host of which CSR’s should be deleted.
id (basestring) – id path parameter. The ID of the Certificate Signing Request to be deleted.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
regenerate_ise_root_ca
(remove_existing_ise_intermediate_csr=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API will initiate regeneration of ISE root CA certificate chain. Response contains id which can be used to track the status. Setting “removeExistingISEIntermediateCSR” to true will remove existing ISE Intermediate CSR.
- Parameters
remove_existing_ise_intermediate_csr (boolean) – Setting this attribute to true will remove existing ISE Intermediate CSR, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
renew_certificates
(cert_type=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API will initiate regeneration of certificates. Response contains id which can be used to track the status.
- Parameters
cert_type (string) – certType, property of the request body. Available values are ‘IMS’ and ‘OCSP’.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
bind_csr
(admin=None, allow_extended_validity=None, allow_out_of_date_cert=None, allow_replacement_of_certificates=None, allow_replacement_of_portal_group_tag=None, data=None, eap=None, host_name=None, id=None, ims=None, name=None, portal=None, portal_group_tag=None, pxgrid=None, radius=None, saml=None, validate_certificate_extensions=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ - Bind CA Signed Certificate. NOTE: This API requires an
existing Certificate Signing Request, and the root certificate must already be trusted. NOTE: The certificate may have a validity period longer than 398 days. It may be untrusted by many browsers. NOTE: Request Parameters accepting True and False as input can be replaced by 1 and 0 respectively. Following Parameters are used in POST body PARAMETER DESCRIPTION EXAMPLE name Friendly name of the certificate. Signed Certificate data Plain-text contents of the certificate file. Every space needs to be replaced with newline escape sequence (
- )
(required). awk ‘NF {sub(/
- /, “”); printf
“%sn”,$0;}’ <<your .pem file>> allowExtendedValidity Allow the certificates greater than validity of 398 days (required) false allowOutOfDateCert Allow out of date certificates (required) false allowReplacementOfCertificates Allow Replacement of certificates (required) false allowReplacementOfPortalGroupTag Allow Replacement of Portal Group Tag (required) false admin Use certificate to authenticate the ISE Admin Portal false eap Use certificate for EAP protocols that use SSL/TLS tunneling false radius Use certificate for RADSec server false pxgrid Use certificate for the pxGrid Controller false ims Use certificate for the ISE Messaging Service false saml Use certificate for SAML Signing false portal Use certificate for portal false portalGroupTag Portal Group Tag for using certificate with portal role Default Portal Certificate Group validateCertificateExtensions Validate Certificate Extensions false Following Roles can be used in any combinations ROLE DEFAULT WARNING Admin False Enabling Admin role for this certificate will cause an application server restart on the selected node. Note: Make sure required Certificate Chain is imported under Trusted Certificates EAP Authentication False Only one system certificate can be used for EAP. Assigning EAP to this certificate will remove the assignment from another certificate. Note: Make sure required Certificate Chain is imported under Trusted Certificates RADIUS DTLS False Only one system certificate can be used for DTLS. Assigning DTLS to this certificate will remove the assignment from another certificate. Note: Make sure required Certificate Chain is imported under Trusted Certificates SAML False SAML cannot be used with other Usage. Enabling SAML will uncheck all other Usage. Note: Make sure required Certificate Chain is imported under Trusted Certificates .
- Args:
- admin(boolean): Use certificate to authenticate the ISE
Admin Portal, property of the request body.
- allow_extended_validity(boolean): Allow import of
certificates with validity greater than 398 days (required), property of the request body.
- allow_out_of_date_cert(boolean): Allow out of date
certificates (required), property of the request body.
- allow_replacement_of_certificates(boolean): Allow
Replacement of certificates (required), property of the request body.
- allow_replacement_of_portal_group_tag(boolean): Allow
Replacement of Portal Group Tag (required), property of the request body.
- data(string): Signed Certificate data (required),
property of the request body.
- eap(boolean): Use certificate for EAP protocols that use
SSL/TLS tunneling, property of the request body.
- host_name(string): Name of Host whose CSR ID has been
provided (required), property of the request body.
- id(string): ID of the generated CSR (required), property
of the request body.
- ims(boolean): Use certificate for the ISE Messaging
Service, property of the request body.
- name(string): Friendly Name of the certificate, property
of the request body.
- portal(boolean): Use for portal, property of the request
body.
- portal_group_tag(string): Set Group tag, property of the
request body.
- pxgrid(boolean): Use certificate for the pxGrid
Controller, property of the request body.
- radius(boolean): Use certificate for the RADSec server,
property of the request body.
- saml(boolean): Use certificate for SAML Signing,
property of the request body.
- validate_certificate_extensions(boolean): Validate
Certificate Extensions, property of the request body.
- headers(dict): Dictionary of HTTP Headers to send with the Request
.
- payload(dict): A JSON serializable Python object to send in the
body of the Request.
- active_validation(bool): Enable/Disable payload validation.
Defaults to True.
- **query_parameters: Additional query parameters (provides
support for parameters that may be added in the future).
Returns:
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Raises:
TypeError: If the parameter types are incorrect. MalformedRequest: If the request body created is invalid. ApiError: If the Identity Services Engine cloud returns an error.
-
export_system_certificate
(export=None, id=None, password=None, dirpath=None, save_file=None, filename=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Export System Certificate. Following Parameters are used in POST body PARAMETER DESCRIPTION EXAMPLE id ID of a System Certificate(required) < SYSTEM_CERT_ID > export One of the below option is required “CERTIFICATE” : Export only Certificate without Private Key “CERTIFICATE_WITH_PRIVATE_KEY” : Export both Certificate and Private Key( “certificatePassword” is required) CERTIFICATE_WITH_PRIVATE_KEY password Certificate Password (required if “export” : CERTIFICATE_WITH_PRIVATE_KEY ) Password Constraints: Alphanumeric Minimum of 8 Characters Maximum of 100 Characters Passw*** NOTE: The response of this API carries a ZIP file containing the certificate and private key if “export” : “CERTIFICATE_WITH_PRIVATE_KEY” in the request. If “export” : “CERTIFICATE” in request body, the response carries a ZIP file containing only the certificate. WARNING: Exporting a private key is not a secure operation. It could lead to possible exposure of the private key. .
- Parameters
export (string) – export, property of the request body. Available values are ‘CERTIFICATE’ and ‘CERTIFICATE_WITH_PRIVATE_KEY’.
id (string) – id, property of the request body.
password (string) – password, property of the request body.
dirpath (basestring) – Directory absolute path. Defaults to os.getcwd().
save_file (bool) – Enable or disable automatic file creation of raw response.
filename (basestring) – The filename used to save the download file.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
The DownloadResponse wrapper. Wraps the urllib3.response.HTTPResponse. For more information check the urlib3 documentation
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
DownloadFailure – If was not able to download the raw
response to a file. –
-
import_system_certificate
(admin=None, allow_extended_validity=None, allow_out_of_date_cert=None, allow_replacement_of_certificates=None, allow_replacement_of_portal_group_tag=None, allow_sha1_certificates=None, allow_wild_card_certificates=None, data=None, eap=None, ims=None, name=None, password=None, portal=None, portal_group_tag=None, portal_tag_transfer_for_same_subject=None, private_key_data=None, pxgrid=None, radius=None, role_transfer_for_same_subject=None, saml=None, validate_certificate_extensions=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ - Import an X509 certificate as a system certificate. NOTE:
The certificate may have a validity period longer than 398 days. It may be untrusted by many browsers. NOTE: Request Parameters accepting True and False as input can be replaced by 1 and 0 respectively. Following Parameters are used in POST body PARAMETER DESCRIPTION EXAMPLE name Friendly name of the certificate. System Certificate password Password of the certificate to be imported (required). Passw*** data Plain-text contents of the certificate file. Every space needs to be replaced with newline escape sequence (
- ) (required). awk ‘NF
{sub(/
- /, “”); printf “%sn”,$0;}’ <<your .pem file>>
privateKeyData Plain-text contents of the private key file. Every space needs to be replaced with newline escape sequence (
) (required). awk ‘NF {sub(/ /,
“”); printf “%sn”,$0;}’ <<your .pem file>> allowOutOfDateCert Allow out of date certificates (required) false allowSHA1Certificates Allow SHA1 based certificates (required) false allowExtendedValidity Allow the certificates greater than validity of 398 days (required) false roleTransferForSameSubject Allow the transfer of roles to certificates with same subject false portalTagTransferForSameSubject Acquire the group tag of the matching certificate false admin Use certificate to authenticate the ISE Admin Portal false eap Use certificate for EAP protocols that use SSL/TLS tunneling false radius Use certificate for RADSec server false pxgrid Use certificate for the pxGrid Controller false ims Use certificate for the ISE Messaging Service false saml Use certificate for SAML Signing false portal Use certificate for portal false portalGroupTag Portal Group Tag for using certificate with portal role Default Portal Certificate Group allowReplacementOfPortalGroupTag Allow Replacement of Portal Group Tag (required) false allowWildCardCertificates Allow use of WildCards in certificates false validateCertificateExtensions Validate Certificate Extensions false Following Roles can be used in any combinations ROLE DEFAULT WARNING Admin False Enabling Admin role for this certificate will cause an application server restart on the selected node. Note: Make sure required Certificate Chain is imported under Trusted Certificates EAP Authentication False Only one system certificate can be used for EAP. Assigning EAP to this certificate will remove the assignment from another certificate. Note: Make sure required Certificate Chain is imported under Trusted Certificates RADIUS DTLS False Only one system certificate can be used for DTLS. Assigning DTLS to this certificate will remove the assignment from another certificate. Note: Make sure required Certificate Chain is imported under Trusted Certificates SAML False SAML cannot be used with other Usage. Enabling SAML will uncheck all other Usage. Note: Make sure required Certificate Chain is imported under Trusted Certificates .
- Args:
- admin(boolean): Use certificate to authenticate the ISE
Admin Portal, property of the request body.
- allow_extended_validity(boolean): Allow import of
certificates with validity greater than 398 days (required), property of the request body.
- allow_out_of_date_cert(boolean): Allow out of date
certificates (required), property of the request body.
- allow_replacement_of_certificates(boolean): Allow
Replacement of certificates (required), property of the request body.
- allow_replacement_of_portal_group_tag(boolean): Allow
Replacement of Portal Group Tag (required), property of the request body.
- allow_sha1_certificates(boolean): Allow SHA1 based
certificates (required), property of the request body.
- allow_wild_card_certificates(boolean): Allow Wildcard
Certificates, property of the request body.
- data(string): Certificate Content (required), property
of the request body.
- eap(boolean): Use certificate for EAP protocols that use
SSL/TLS tunneling, property of the request body.
- ims(boolean): Use certificate for the ISE Messaging
Service, property of the request body.
- name(string): Name of the certificate, property of the
request body.
- password(string): Certificate Password (required).,
property of the request body.
- portal(boolean): Use for portal, property of the request
body.
- portal_group_tag(string): Set Group tag, property of the
request body.
- portal_tag_transfer_for_same_subject(boolean): Allow
overwriting the portal tag from matching certificate of same subject, property of the request body.
- private_key_data(string): Private Key data (required),
property of the request body.
- pxgrid(boolean): Use certificate for the pxGrid
Controller, property of the request body.
- radius(boolean): Use certificate for the RADSec server,
property of the request body.
- role_transfer_for_same_subject(boolean): Allow transfer
of roles for certificate with matching subject , property of the request body.
- saml(boolean): Use certificate for SAML Signing,
property of the request body.
- validate_certificate_extensions(boolean): Validate
Certificate Extensions, property of the request body.
- headers(dict): Dictionary of HTTP Headers to send with the Request
.
- payload(dict): A JSON serializable Python object to send in the
body of the Request.
- active_validation(bool): Enable/Disable payload validation.
Defaults to True.
- **query_parameters: Additional query parameters (provides
support for parameters that may be added in the future).
Returns:
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Raises:
TypeError: If the parameter types are incorrect. MalformedRequest: If the request body created is invalid. ApiError: If the Identity Services Engine cloud returns an error.
-
get_system_certificates
(host_name, filter=None, filter_type=None, page=None, size=None, sort=None, sort_by=None, headers=None, **query_parameters)[source]¶ This API supports Filtering, Sorting and Pagination. Filtering and Sorting supported on below mentioned attributes: friendlyName issuedTo issuedBy validFrom Supported Date Format: yyyy-MM-dd HH:mm:ss Supported Operators: EQ, NEQ, GT and LT expirationDate Supported Date Format: yyyy-MM-dd HH:mm:ss Supported Operators: EQ, NEQ, GT and LT .
- Parameters
host_name (basestring) – hostName path parameter. Name of the host of which system certificates should be returned.
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sort (basestring) – sort query parameter. sort type asc or desc.
sort_by (basestring) – sortBy query parameter. sort column by which objects needs to be sorted.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. OPERATOR DESCRIPTION EQ Equals NEQ Not Equals GT Greater Than LT Less Then STARTSW Starts With NSTARTSW Not Starts With ENDSW Ends With NENDSW Not Ends With CONTAINS Contains NCONTAINS Not Contains .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_system_certificates_generator
(host_name, filter=None, filter_type=None, page=None, size=None, sort=None, sort_by=None, headers=None, **query_parameters)[source]¶ This API supports Filtering, Sorting and Pagination. Filtering and Sorting supported on below mentioned attributes: friendlyName issuedTo issuedBy validFrom Supported Date Format: yyyy-MM-dd HH:mm:ss Supported Operators: EQ, NEQ, GT and LT expirationDate Supported Date Format: yyyy-MM-dd HH:mm:ss Supported Operators: EQ, NEQ, GT and LT .
- Parameters
host_name (basestring) – hostName path parameter. Name of the host of which system certificates should be returned.
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sort (basestring) – sort query parameter. sort type asc or desc.
sort_by (basestring) – sortBy query parameter. sort column by which objects needs to be sorted.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. OPERATOR DESCRIPTION EQ Equals NEQ Not Equals GT Greater Than LT Less Then STARTSW Starts With NSTARTSW Not Starts With ENDSW Ends With NENDSW Not Ends With CONTAINS Contains NCONTAINS Not Contains .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_system_certificate_by_id
(host_name, id, headers=None, **query_parameters)[source]¶ This API displays details of a System Certificate of a particular node based on a given HostName and ID.
- Parameters
host_name (basestring) – hostName path parameter. Name of the host of which system certificates should be returned.
id (basestring) – id path parameter. The id of the system certificate.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_system_certificate
(host_name, id, admin=None, allow_replacement_of_portal_group_tag=None, description=None, eap=None, expiration_ttl_period=None, expiration_ttl_units=None, ims=None, name=None, portal=None, portal_group_tag=None, portal_tag_transfer_for_same_subject=None, pxgrid=None, radius=None, renew_self_signed_certificate=None, role_transfer_for_same_subject=None, saml=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Update a System Certificate. NOTE: Renewing a certificate will cause an application server restart on the selected node. NOTE: Request Parameters accepting True and False as input can be replaced by 1 and 0 respectively. Following Parameters are used in POST body PARAMETER DESCRIPTION EXAMPLE name Friendly name of the certificate. System Certificate description Description of the Certificate Default Description admin Use certificate to authenticate the ISE Admin Portal false eap Use certificate for EAP protocols that use SSL/TLS tunneling false radius Use certificate for RADSec server false pxgrid Use certificate for the pxGrid Controller false ims Use certificate for the ISE Messaging Service false saml Use certificate for SAML Signing false portal Use certificate for portal false portalGroupTag Portal Group Tag for using certificate with portal role Default Portal Certificate Group allowReplacementOfPortalGroupTag Allow Replacement of Portal Group Tag (required) false roleTransferForSameSubject Allow the transfer of roles to certificates with same subject false portalTagTransferForSameSubject Acquire the group tag of the matching certificate false renewSelfSignedCertificate Renew Self Signed Certificate false expirationTTLPeriod Expiration Period 365 expirationTTLUnits Expiration Units in one of the below formats days / weeks / months / years days Following Roles can be used in any combinations ROLE DEFAULT WARNING Admin False Enabling Admin role for this certificate will cause an application server restart on the selected node. Note: Make sure required Certificate Chain is imported under Trusted Certificates EAP Authentication False Only one system certificate can be used for EAP. Assigning EAP to this certificate will remove the assignment from another certificate. Note: Make sure required Certificate Chain is imported under Trusted Certificates RADIUS DTLS False Only one system certificate can be used for DTLS. Assigning DTLS to this certificate will remove the assignment from another certificate. Note: Make sure required Certificate Chain is imported under Trusted Certificates SAML False SAML cannot be used with other Usage. Enabling SAML will uncheck all other Usage. Note: Make sure required Certificate Chain is imported under Trusted Certificates .
- Parameters
admin (boolean) – Use certificate to authenticate the ISE Admin Portal, property of the request body.
allow_replacement_of_portal_group_tag (boolean) – Allow Replacement of Portal Group Tag (required), property of the request body.
description (string) – Description of System Certificate, property of the request body.
eap (boolean) – Use certificate for EAP protocols that use SSL/TLS tunneling, property of the request body.
expiration_ttl_period (integer) – expirationTTLPeriod, property of the request body.
expiration_ttl_units (string) – expirationTTLUnits, property of the request body. Available values are ‘days’, ‘months’, ‘weeks’ and ‘years’.
ims (boolean) – Use certificate for the ISE Messaging Service, property of the request body.
name (string) – Name of the certificate, property of the request body.
portal (boolean) – Use for portal, property of the request body.
portal_group_tag (string) – Set Group tag, property of the request body.
portal_tag_transfer_for_same_subject (boolean) – Allow overwriting the portal tag from matching certificate of same subject, property of the request body.
pxgrid (boolean) – Use certificate for the pxGrid Controller, property of the request body.
radius (boolean) – Use certificate for the RADSec server, property of the request body.
renew_self_signed_certificate (boolean) – Renew Self Signed Certificate, property of the request body.
role_transfer_for_same_subject (boolean) – Allow transfer of roles for certificate with matching subject , property of the request body.
saml (boolean) – Use certificate for SAML Signing, property of the request body.
id (basestring) – id path parameter. The ID of the System Certificate to be updated.
host_name (basestring) – hostName path parameter. Name of Host whose certificate needs to be updated.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_system_certificate_by_id
(host_name, id, headers=None, **query_parameters)[source]¶ This API deletes a System Certificate of a particular node based on a given HostName and ID.
- Parameters
host_name (basestring) – hostName path parameter. Name of the host from which the System Certificate needs to be deleted.
id (basestring) – id path parameter. The ID of the System Certificate to be deleted.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_trusted_certificates
(filter=None, filter_type=None, page=None, size=None, sort=None, sort_by=None, headers=None, **query_parameters)[source]¶ This API supports Filtering, Sorting and Pagination. Filtering and Sorting supported on below mentioned attributes: friendlyName subject issuedTo issuedBy validFrom Supported Date Format: yyyy-MM- dd HH:mm:ss Supported Operators: EQ, NEQ, GT and LT expirationDate Supported Date Format: yyyy-MM-dd HH:mm:ss Supported Operators: EQ, NEQ, GT and LT status Allowed values: enabled, disabled Supported Operators: EQ, NEQ .
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sort (basestring) – sort query parameter. sort type asc or desc.
sort_by (basestring) – sortBy query parameter. sort column by which objects needs to be sorted.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. OPERATOR DESCRIPTION EQ Equals NEQ Not Equals GT Greater Than LT Less Then STARTSW Starts With NSTARTSW Not Starts With ENDSW Ends With NENDSW Not Ends With CONTAINS Contains NCONTAINS Not Contains .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_trusted_certificates_generator
(filter=None, filter_type=None, page=None, size=None, sort=None, sort_by=None, headers=None, **query_parameters)[source]¶ This API supports Filtering, Sorting and Pagination. Filtering and Sorting supported on below mentioned attributes: friendlyName subject issuedTo issuedBy validFrom Supported Date Format: yyyy-MM- dd HH:mm:ss Supported Operators: EQ, NEQ, GT and LT expirationDate Supported Date Format: yyyy-MM-dd HH:mm:ss Supported Operators: EQ, NEQ, GT and LT status Allowed values: enabled, disabled Supported Operators: EQ, NEQ .
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sort (basestring) – sort query parameter. sort type asc or desc.
sort_by (basestring) – sortBy query parameter. sort column by which objects needs to be sorted.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. OPERATOR DESCRIPTION EQ Equals NEQ Not Equals GT Greater Than LT Less Then STARTSW Starts With NSTARTSW Not Starts With ENDSW Ends With NENDSW Not Ends With CONTAINS Contains NCONTAINS Not Contains .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
export_trusted_certificate
(id, dirpath=None, save_file=None, filename=None, headers=None, **query_parameters)[source]¶ The response of this API carries a trusted certificate file mapped to the requested id.
- Parameters
id (basestring) – id path parameter. The ID of the Trusted Certificate to be exported.
dirpath (basestring) – Directory absolute path. Defaults to os.getcwd().
save_file (bool) – Enable or disable automatic file creation of raw response.
filename (basestring) – The filename used to save the download file.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
The DownloadResponse wrapper. Wraps the urllib3.response.HTTPResponse. For more information check the urlib3 documentation
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
DownloadFailure – If was not able to download the raw
response to a file. –
-
import_trust_certificate
(allow_basic_constraint_cafalse=None, allow_out_of_date_cert=None, allow_sha1_certificates=None, data=None, description=None, name=None, trust_for_certificate_based_admin_auth=None, trust_for_cisco_services_auth=None, trust_for_client_auth=None, trust_for_ise_auth=None, validate_certificate_extensions=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ - Import an X509 certificate as a trust certificate. NOTE:
Request Parameters accepting True and False as input can be replaced by 1 and 0 respectively. Following Parameters are used in POST body PARAMETER DESCRIPTION EXAMPLE name Friendly name of the certificate Trust Certificate description Description of the certificate Passw*** data Plain-text contents of the certificate file. Every space needs to be replaced with newline escape sequence (
- )
(required). awk ‘NF {sub(/
- /, “”); printf
“%sn”,$0;}’ <<your .pem file>> allowOutOfDateCert Allow out of date certificates (required) false allowSHA1Certificates Allow SHA1 based certificates (required) false trustForIseAuth Trust for authentication within ISE false trustForClientAuth Trust for client authentication and Syslog false trustForCertificateBasedAdminAuth Trust for Certificate based Admin authentication false trustForCiscoServicesAuth Trust for authentication of Cisco Services false validateCertificateExtensions Validate extensions for trust certificate false NOTE: If name is not set, a default name of the following format will be generated: common-name#issuer#nnnnn where “nnnnn” is a unique number. You can always change the friendly name later by editing the certificate. You must choose how this certificate will be trusted in ISE. The objective here is to distinguish between certificates that are used for trust within an ISE deployment and public certificates that are used to trust Cisco services. Typically, you will not want to use a given certificate for both purposes. Trusted For Usage Authentication within ISE Use “trustForIseAuth”:true if the certificate is used for trust within ISE, such as for secure communication between ISE nodes Client authentication and Syslog Use “trustForClientAuth”:true if the certificate is to be used for authentication of endpoints that contact ISE over the EAP protocol. Also check this box if certificate is used to trust a Syslog server. Make sure to have keyCertSign bit asserted under KeyUsage extension for this certificate. Note: “” can be set true only if the “trustForIseAuth” has been set true. Certificate based admin authentication Use “trustForCertificateBasedAdminAuth”:true if the certificate is used for trust within ISE, such as for secure communication between ISE nodes Note: “trustForCertificateBasedAdminAuth” can be set true only if “trustForIseAuth” and “trustForClientAuth” are true. Authentication of Cisco Services Use “trustForCiscoServicesAuth”:true if the certificate is to be used for trusting external Cisco services, such as Feed Service. .
- Args:
- allow_basic_constraint_cafalse(boolean): Allow
Certificates with Basic Constraints CA Field as False (required), property of the request body.
- allow_out_of_date_cert(boolean): Allow out of date
certificates (required), property of the request body.
- allow_sha1_certificates(boolean): Allow SHA1 based
certificates (required), property of the request body.
- data(string): Certificate content (required), property
of the request body.
- description(string): Description of the certificate,
property of the request body.
- name(string): Name of the certificate, property of the
request body.
- trust_for_certificate_based_admin_auth(boolean): Trust
for Certificate based Admin authentication, property of the request body.
- trust_for_cisco_services_auth(boolean): Trust for
authentication of Cisco Services, property of the request body.
- trust_for_client_auth(boolean): Trust for client
authentication and Syslog, property of the request body.
- trust_for_ise_auth(boolean): Trust for authentication
within ISE, property of the request body.
- validate_certificate_extensions(boolean): Validate trust
certificate extension, property of the request body.
- headers(dict): Dictionary of HTTP Headers to send with the Request
.
- payload(dict): A JSON serializable Python object to send in the
body of the Request.
- active_validation(bool): Enable/Disable payload validation.
Defaults to True.
- **query_parameters: Additional query parameters (provides
support for parameters that may be added in the future).
Returns:
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Raises:
TypeError: If the parameter types are incorrect. MalformedRequest: If the request body created is invalid. ApiError: If the Identity Services Engine cloud returns an error.
-
get_trusted_certificate_by_id
(id, headers=None, **query_parameters)[source]¶ This API can displays details of a Trust Certificate based on a given ID.
- Parameters
id (basestring) – id path parameter. The id of the trust certificate.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_trusted_certificate
(id, authenticate_before_crl_received=None, automatic_crl_update=None, automatic_crl_update_period=None, automatic_crl_update_units=None, crl_distribution_url=None, crl_download_failure_retries=None, crl_download_failure_retries_units=None, description=None, download_crl=None, enable_ocsp_validation=None, enable_server_identity_check=None, ignore_crl_expiration=None, name=None, non_automatic_crl_update_period=None, non_automatic_crl_update_units=None, reject_if_no_status_from_ocs_p=None, reject_if_unreachable_from_ocs_p=None, selected_ocsp_service=None, status=None, trust_for_certificate_based_admin_auth=None, trust_for_cisco_services_auth=None, trust_for_client_auth=None, trust_for_ise_auth=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Update a trusted certificate present in ISE trust store. Following Parameters are used in PUT request body PARAMETER DESCRIPTION EXAMPLE name Friendly name of the certificate(required) Trust Certificate status Status of the certificate Enabled description Description of the certificate Certificate for secure connection to cisco.com trustForIseAuth Trust for authentication within ISE false trustForClientAuth Trust for client authentication and Syslog false trustForCertificateBasedAdminAuth Trust for Certificate based Admin authentication false trustForCiscoServicesAuth Trust for authentication of Cisco Services false enableOCSPValidation Switch to enable/disable OCSP Validation false selectedOCSPService Name of selected OCSP Service INTERNAL_OCSP_SERVICE rejectIfNoStatusFromOCSP Switch to reject certificate if there is no status from OCSP false rejectIfUnreachableFromOCSP Switch to reject certificate if unreachable from OCSP false downloadCRL Switch to enable/disable download of CRL false crlDistributionUrl Certificate Revocation List Distribution URL automaticCRLUpdate Switch to enable/disable automatic CRL update false automaticCRLUpdatePeriod Automatic CRL update period 5 automaticCRLUpdateUnits Unit of time for automatic CRL update Minutes nonAutomaticCRLUpdatePeriod Non automatic CRL update period 1 nonAutomaticCRLUpdateUnits Unit of time of non automatic CRL update Hours crlDownloadFailureRetries If CRL download fails, wait time before retry 10 crlDownloadFailureRetriesUnits Unit of time before retry if CRL download fails Minutes enableServerIdentityCheck Switch to enable/disable verification if HTTPS or LDAP server certificate name fits the configured server URL false authenticateBeforeCRLReceived Switch to enable/disable CRL Verification if CRL is not Received false ignoreCRLExpiration Switch to enable/disable ignore CRL Expiration false Trusted For Usage Authentication within ISE Use “trustForIseAuth”:true if the certificate is used for trust within ISE, such as for secure communication between ISE nodes Client authentication and Syslog Use “trustForClientAuth”:true if the certificate is to be used for authentication of endpoints that contact ISE over the EAP protocol. Also check this box if certificate is used to trust a Syslog server. Make sure to have keyCertSign bit asserted under KeyUsage extension for this certificate. Note: “trustForClientAuth” can be set true only if the “trustForIseAuth” has been set true. Certificate based admin authentication Use “trustForCertificateBasedAdminAuth”:true if the certificate is used for trust within ISE, such as for secure communication between ISE nodes Note: “trustForCertificateBasedAdminAuth” can be set true only if “trustForIseAuth” and “trustForClientAuth” are true. Authentication of Cisco Services Use “trustForCiscoServicesAuth”:true if the certificate is to be used for trusting external Cisco services, such as Feed Service. OCSP Configuration Usage Validation against OCSP service Use “enableOCSPValidation”:true to validate the certificate against OCSP service mentioned in the field selectedOCSPService OCSP Service name Use “selectedOCSPService”:”Name of OCSP Service” Name of the OCSP service against which the certificate should be validated Note: “selectedOCSPService” value will on be used if “enableOCSPValidation” has been set true. Reject the request if OCSP returns UNKNOWN status Use “rejectIfNoStatusFromOCSP”:true to reject the certificate if the OCSP service returns UNKNOWN status Note: “rejectIfNoStatusFromOCSP:true” can be used only if “enableOCSPValidation” has been set true. Reject the request if OCSP Responder is unreachable Use “rejectIfUnreachableFromOCSP”:true to reject the certificate if the OCSP service is unreachable. Note: “rejectIfUnreachableFromOCSP:true” can be used only if “enableOCSPValidation” has been set true. Certificate Revocation List Configuration Usage Validation against CRL Use “downloadCRL”:true to validate the certificate against CRL downloaded from URL mentioned in the field crlDistributionUrl CRL distribution url Use “crlDistributionUrl” to specify the URL from where the CRL should be downloaded Note: “crlDistributionUrl” value will only be used if “downloadCRL” has been set true. Retrieve CRL time Use “automaticCRLUpdate”:true and automaticCRLUpdatePeriod, automaticCRLUpdatePeriod to set the time before which CRL is automatically retrieved prior to expiration Use “nonAutomaticCRLUpdatePeriod, nonAutomaticCRLUpdateUnits to set the time period for CRL retrieval in loop. Note: All the above fields can be used only if “downloadCRL” has been set true. If download fails Use “crlDownloadFailureRetries” and “crlDownloadFailureRetriesUnits” to set retry time period if CRL download fails Note: “crlDownloadFailureRetries” and “crlDownloadFailureRetriesUnits” can be used only if “downloadCRL” has been set true. Enable Server Identity Check Use “enableServerIdentityCheck”:true to verify that HTTPS or LDAPS server certificate name fits the configured server URL Note: “enableServerIdentityCheck:true” can be used only if “downloadCRL” has been set true. Bypass CRL Verification if CRL is not Received Use “authenticateBeforeCRLReceived”:true to bypass CRL Verification if CRL is not Received Note: “authenticateBeforeCRLReceived:true” can be used only if “downloadCRL” has been set true. Ignore that CRL is not yet valid or has expired Use “ignoreCRLExpiration”:true to ignore if CRL is not yet valid or expired Note: “ignoreCRLExpiration:true” can be used only if “downloadCRL” has been set true. Note: boolean properties accept integers values as well, with 0 considered as false and other values being considered as true .
- Parameters
authenticate_before_crl_received (boolean) – Switch to enable/disable CRL Verification if CRL is not Received, property of the request body.
automatic_crl_update (boolean) – Switch to enable/disable automatic CRL update, property of the request body.
automatic_crl_update_period (integer) – Automatic CRL update period, property of the request body.
automatic_crl_update_units (string) – Unit of time for automatic CRL update, property of the request body. Available values are ‘Days’, ‘Hours’, ‘Minutes’ and ‘Weeks’.
crl_distribution_url (string) – CRL Distribution URL, property of the request body.
crl_download_failure_retries (integer) – If CRL download fails, wait time before retry, property of the request body.
crl_download_failure_retries_units (string) – Unit of time before retry if CRL download fails, property of the request body. Available values are ‘Days’, ‘Hours’, ‘Minutes’ and ‘Weeks’.
description (string) – Description for trust certificate, property of the request body.
download_crl (boolean) – Switch to enable/disable download of CRL, property of the request body.
enable_ocsp_validation (boolean) – Switch to enable/disable OCSP Validation, property of the request body.
enable_server_identity_check (boolean) – Switch to enable/disable verification if HTTPS or LDAP server certificate name fits the configured server URL, property of the request body.
ignore_crl_expiration (boolean) – Switch to enable/disable ignore CRL Expiration, property of the request body.
name (string) – Friendly name of the certificate, property of the request body.
non_automatic_crl_update_period (integer) – Non automatic CRL update period, property of the request body.
non_automatic_crl_update_units (string) – Unit of time of non automatic CRL update, property of the request body. Available values are ‘Days’, ‘Hours’, ‘Minutes’ and ‘Weeks’.
reject_if_no_status_from_ocs_p (boolean) – Switch to reject certificate if there is no status from OCSP, property of the request body.
reject_if_unreachable_from_ocs_p (boolean) – Switch to reject certificate if unreachable from OCSP, property of the request body.
selected_ocsp_service (string) – Name of selected OCSP Service, property of the request body.
status (string) – status, property of the request body. Available values are ‘Disabled’ and ‘Enabled’.
trust_for_certificate_based_admin_auth (boolean) – Trust for Certificate based Admin authentication, property of the request body.
trust_for_cisco_services_auth (boolean) – Trust for authentication of Cisco Services, property of the request body.
trust_for_client_auth (boolean) – Trust for client authentication and Syslog, property of the request body.
trust_for_ise_auth (boolean) – Trust for authentication within ISE, property of the request body.
id (basestring) – id path parameter. The id of the trust certificate.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_trusted_certificate_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes a Trust Certificate from Trusted Certificate Store based on a given ID.
- Parameters
id (basestring) – id path parameter. The ID of the Trusted Certificate to be deleted.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
clear_threats_and_vulnerabilities¶
-
class
ClearThreatsAndVulnerabilities
[source]¶ Identity Services Engine ClearThreatsAndVulnerabilities API (version: 3.1.0).
Wraps the Identity Services Engine ClearThreatsAndVulnerabilities API and exposes the API as native Python methods that return native Python objects.
Clear Threats and Vulnerabilities API allows the user to delete the ThreatContext and Threat events that are associated with the given MAC Address.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.1
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Example Values
name
String
Yes
Resource Name
id
String
Yes
Resource UUID value
macAddresses
String
Yes
One or more endpoint MAC addresses
[ “00:00:00:00:00:F2”, “00:00:00:00:00:F3” ]
-
clear_threats_and_vulnerabilities
(mac_addresses=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to delete the ThreatContext and Threat events that are associated with the given MAC Address.
- Parameters
mac_addresses (string) – macAddresses, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
clear
(mac_addresses=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for clear_threats_and_vulnerabilities
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the clear threats and vulneribilities.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
consumer¶
-
class
Consumer
[source]¶ Identity Services Engine Consumer API (version: 3.1.0).
Wraps the Identity Services Engine Consumer API and exposes the API as native Python methods that return native Python objects.
# Cisco ISE 3.0 pxGrid REST APIs
## License [Cisco Sample Code License](https://developer.cisco.com/site/license/cisco-sample-code-license/)
## Status These are the status icons for the requests so far. - ⌗ : must create resources to test - 🚧 : incomplete | untested - 🛑 : unsupported | bug
## Environment Variables This collection uses environment variables in scripts in the Tests tab to store data (id, name, portalId, etc.) between requests. This allows you to GET or POST then immediately GET {id} on a resource. Using No Environment will cause this convenience functionality to fail so be sure to choose one.
## Collection Variables This collection includes some default variables that you will want to update or override with environment variables for your ISE deployment. Specifically, you will want to set: - ise_pxg: the ISE PAN node name or IP address. Default: ise.securitydemo.net - rest_username: the username for ERS API access. Must be a member of SuperAdmin, ERSAdmin or ERSOperator groups. Default: admin which is the ISE SuperAdmin - rest_password: Default: C1sco12345
-
create_account
(node_name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ 🚧 AccountCreate.
- Parameters
node_name (string) – nodeName, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(node_name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_account
-
activate_account
(description=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ 🚧 AccountActivate.
- Parameters
description (string) – description, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
lookup_service
(name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ 🚧 ServiceLookup.
- Parameters
name (string) – name, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
access_secret
(peer_node_name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ 🚧 AccessSecret.
- Parameters
peer_node_name (string) – peerNodeName, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
device_administration_authentication_rules¶
-
class
DeviceAdministrationAuthenticationRules
[source]¶ Identity Services Engine Device Administration - Authentication Rules API (version: 3.1.0).
Wraps the Identity Services Engine Device Administration - Authentication Rules API and exposes the API as native Python methods that return native Python objects.
-
get_device_admin_authentication_rules
(policy_id, headers=None, **query_parameters)[source]¶ Device Admin Get authentication rules.
- Parameters
policy_id (basestring) – policyId path parameter. Policy id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(policy_id, headers=None, **query_parameters)[source]¶ Alias for get_device_admin_authentication_rules
-
create_device_admin_authentication_rule
(policy_id, identity_source_name=None, if_auth_fail=None, if_process_fail=None, if_user_not_found=None, link=None, rule=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Device Admin Create authentication rule: Rule must include name and condition. Condition has hierarchical structure which define a set of conditions for which authentication policy rule could be match. Condition can be either reference to a stored Library condition, using model ConditionReference or dynamically built conditions which are not stored in the conditions Library, using models ConditionAttributes, ConditionAndBlock, ConditionOrBlock . .
- Parameters
identity_source_name (string) – Identity source name from the identity stores, property of the request body.
if_auth_fail (string) – Action to perform when authentication fails such as Bad credentials, disabled user and so on, property of the request body.
if_process_fail (string) – Action to perform when ISE is uanble to access the identity database, property of the request body.
if_user_not_found (string) – Action to perform when user is not found in any of identity stores, property of the request body.
link (object) – link, property of the request body.
rule (object) – Common attributes in rule authentication/authorization, property of the request body.
policy_id (basestring) – policyId path parameter. Policy id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(policy_id, identity_source_name=None, if_auth_fail=None, if_process_fail=None, if_user_not_found=None, link=None, rule=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_device_admin_authentication_rule
-
reset_hit_counts_device_admin_authentication_rules
(policy_id, headers=None, **query_parameters)[source]¶ Device Admin Reset HitCount for Authentication Rules.
- Parameters
policy_id (basestring) – policyId path parameter. Policy id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
reset_hit_counts_by_id
(policy_id, headers=None, **query_parameters)[source]¶ Alias for reset_hit_counts_device_admin_authentication_rules
-
get_device_admin_authentication_rule_by_id
(id, policy_id, headers=None, **query_parameters)[source]¶ Device Admin Get rule attributes.
- Parameters
policy_id (basestring) – policyId path parameter. Policy id.
id (basestring) – id path parameter. Rule id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_device_admin_authentication_rule_by_id
(id, policy_id, identity_source_name=None, if_auth_fail=None, if_process_fail=None, if_user_not_found=None, link=None, rule=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Device Admin Update rule.
- Parameters
identity_source_name (string) – Identity source name from the identity stores, property of the request body.
if_auth_fail (string) – Action to perform when authentication fails such as Bad credentials, disabled user and so on, property of the request body.
if_process_fail (string) – Action to perform when ISE is uanble to access the identity database, property of the request body.
if_user_not_found (string) – Action to perform when user is not found in any of identity stores, property of the request body.
link (object) – link, property of the request body.
rule (object) – Common attributes in rule authentication/authorization, property of the request body.
policy_id (basestring) – policyId path parameter. Policy id.
id (basestring) – id path parameter. Rule id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, policy_id, identity_source_name=None, if_auth_fail=None, if_process_fail=None, if_user_not_found=None, link=None, rule=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
-
delete_device_admin_authentication_rule_by_id
(id, policy_id, headers=None, **query_parameters)[source]¶ Device Admin Delete rule.
- Parameters
policy_id (basestring) – policyId path parameter. Policy id.
id (basestring) – id path parameter. Rule id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
device_administration_command_set¶
-
class
DeviceAdministrationCommandSet
[source]¶ Identity Services Engine Device Administration - Command Set API (version: 3.1.0).
Wraps the Identity Services Engine Device Administration - Command Set API and exposes the API as native Python methods that return native Python objects.
-
get_device_admin_command_sets
(headers=None, **query_parameters)[source]¶ Device Admin Return list of command sets. (Other CRUD APIs available through ERS).
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(list): A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(headers=None, **query_parameters)[source]¶ Alias for get_device_admin_command_sets
-
device_administration_conditions¶
-
class
DeviceAdministrationConditions
[source]¶ Identity Services Engine Device Administration - Conditions API (version: 3.1.0).
Wraps the Identity Services Engine Device Administration - Conditions API and exposes the API as native Python methods that return native Python objects.
-
get_device_admin_conditions
(headers=None, **query_parameters)[source]¶ Device Admin Returns list of library conditions.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(headers=None, **query_parameters)[source]¶ Alias for get_device_admin_conditions
-
create_device_admin_condition
(attribute_name=None, attribute_value=None, children=None, condition_type=None, dates_range=None, dates_range_exception=None, description=None, dictionary_name=None, dictionary_value=None, hours_range=None, hours_range_exception=None, id=None, is_negate=None, link=None, name=None, operator=None, week_days=None, week_days_exception=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Device Admin Creates a library condition: Library Condition has hierarchical structure which define a set of condition for which authentication and authorization policy rules could be match. Condition can be compose from single dictionary attribute name and value using model LibraryConditionAttributes , or from combination of dictionary attributes with logical operation of AND/OR between them, using models: LibraryConditionAndBlock or LibraryConditionOrBlock . When using AND/OR blocks, the condition will include inner layers inside these blocks, these layers are built using the inner condition models: ConditionAttributes , ConditionAndBlock , ConditionOrBlock , that represent dynamically built Conditions which are not stored in the conditions Library, or using ConditionReference , which includes an ID to existing stored condition in the library. The LibraryCondition models can only be used in the outer-most layer (root of the condition) and must always include the condition name. When using one of the 3 inner condition models ( ConditionAttributes, ConditionAndBlock, ConditionOrBlock ), condition name cannot be included in the request, since these will not be stored in the conditions library, and used only as inner members of the root condition. When using ConditionReference model in inner layers, the condition name is not required. ConditionReference objects can also include a reference ID to a condition of type TimeAndDate . .
- Parameters
attribute_name (string) – Dictionary attribute name, property of the request body.
attribute_value (string) – Attribute value for condition Value type is specified in dictionary object if multiple values allowed is specified in dictionary object, property of the request body.
children (list) – In case type is andBlock or orBlock addtional conditions will be aggregated under this logical (OR/AND) condition, property of the request body (list of objects).
condition_type (string) – Inidicates whether the record is the condition itself(data) or a logical(or,and) aggregation Data type enum(reference,single) indicates than “conditonId” OR “ConditionAttrs” fields should contain condition data but not both Logical aggreation(and,or) enum indicates that additional conditions are present under the children field, property of the request body. Available values are ‘ConditionAndBlock’, ‘ConditionAttributes’, ‘ConditionOrBlock’, ‘ConditionReference’, ‘LibraryConditionAndBlock’, ‘LibraryConditionAttributes’, ‘LibraryConditionOrBlock’ and ‘TimeAndDateCondition’.
dates_range (object) – Defines for which date/s TimeAndDate condition will be matched Options are Date range, for specific date, the same date should be used for start/end date Default no specific dates In order to reset the dates to have no specific dates Date format yyyy- mm-dd (MM = month, dd = day, yyyy = year), property of the request body.
dates_range_exception (object) – Defines for which date/s TimeAndDate condition will be matched Options are Date range, for specific date, the same date should be used for start/end date Default no specific dates In order to reset the dates to have no specific dates Date format yyyy- mm-dd (MM = month, dd = day, yyyy = year), property of the request body.
description (string) – Condition description, property of the request body.
dictionary_name (string) – Dictionary name, property of the request body.
dictionary_value (string) – Dictionary value, property of the request body.
hours_range (object) – Defines for which hours a TimeAndDate condition will be matched Time format hh:mm ( h = hour , mm = minutes ) Default All Day , property of the request body.
hours_range_exception (object) – Defines for which hours a TimeAndDate condition will be matched Time format hh:mm ( h = hour , mm = minutes ) Default All Day , property of the request body.
id (string) – id, property of the request body.
is_negate (boolean) – Indicates whereas this condition is in negate mode, property of the request body.
link (object) – link, property of the request body.
name (string) – Condition name, property of the request body.
operator (string) – Equality operator, property of the request body. Available values are ‘contains’, ‘endsWith’, ‘equals’, ‘greaterOrEquals’, ‘greaterThan’, ‘in’, ‘ipEquals’, ‘ipGreaterThan’, ‘ipLessThan’, ‘ipNotEquals’, ‘lessOrEquals’, ‘lessThan’, ‘matches’, ‘notContains’, ‘notEndsWith’, ‘notEquals’, ‘notIn’, ‘notStartsWith’ and ‘startsWith’.
week_days (list) – Defines for which days this condition will be matched Days format Arrays of WeekDay enums Default List of All week days, property of the request body (list of strings. Available values are ‘Friday’, ‘Monday’, ‘Saturday’, ‘Sunday’, ‘Thursday’, ‘Tuesday’ and ‘Wednesday’).
week_days_exception (list) – Defines for which days this condition will NOT be matched Days format Arrays of WeekDay enums Default Not enabled, property of the request body (list of strings. Available values are ‘Friday’, ‘Monday’, ‘Saturday’, ‘Sunday’, ‘Thursday’, ‘Tuesday’ and ‘Wednesday’).
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(attribute_name=None, attribute_value=None, children=None, condition_type=None, dates_range=None, dates_range_exception=None, description=None, dictionary_name=None, dictionary_value=None, hours_range=None, hours_range_exception=None, id=None, is_negate=None, link=None, name=None, operator=None, week_days=None, week_days_exception=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_device_admin_condition
-
get_device_admin_conditions_for_authentication_rules
(headers=None, **query_parameters)[source]¶ Device Admin Returns list of library conditions for authentication rules.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_authentication_rules
(headers=None, **query_parameters)[source]¶ Alias for get_device_admin_conditions_for_authentication_rules
Device Admin Returns list of library conditions for authorization rules.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_device_admin_condition_by_name
(name, headers=None, **query_parameters)[source]¶ Device Admin Returns a library condition.
- Parameters
name (basestring) – name path parameter. Condition name.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_name
(name, headers=None, **query_parameters)[source]¶ Alias for get_device_admin_condition_by_name
-
update_device_admin_condition_by_name
(name, attribute_name=None, attribute_value=None, children=None, condition_type=None, dates_range=None, dates_range_exception=None, description=None, dictionary_name=None, dictionary_value=None, hours_range=None, hours_range_exception=None, id=None, is_negate=None, link=None, operator=None, week_days=None, week_days_exception=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Device Admin Update library condition using condition name.
- Parameters
attribute_name (string) – Dictionary attribute name, property of the request body.
attribute_value (string) – Attribute value for condition Value type is specified in dictionary object if multiple values allowed is specified in dictionary object, property of the request body.
children (list) – In case type is andBlock or orBlock addtional conditions will be aggregated under this logical (OR/AND) condition, property of the request body (list of objects).
condition_type (string) – Inidicates whether the record is the condition itself(data) or a logical(or,and) aggregation Data type enum(reference,single) indicates than “conditonId” OR “ConditionAttrs” fields should contain condition data but not both Logical aggreation(and,or) enum indicates that additional conditions are present under the children field, property of the request body. Available values are ‘ConditionAndBlock’, ‘ConditionAttributes’, ‘ConditionOrBlock’, ‘ConditionReference’, ‘LibraryConditionAndBlock’, ‘LibraryConditionAttributes’, ‘LibraryConditionOrBlock’ and ‘TimeAndDateCondition’.
dates_range (object) – Defines for which date/s TimeAndDate condition will be matched Options are Date range, for specific date, the same date should be used for start/end date Default no specific dates In order to reset the dates to have no specific dates Date format yyyy- mm-dd (MM = month, dd = day, yyyy = year), property of the request body.
dates_range_exception (object) – Defines for which date/s TimeAndDate condition will be matched Options are Date range, for specific date, the same date should be used for start/end date Default no specific dates In order to reset the dates to have no specific dates Date format yyyy- mm-dd (MM = month, dd = day, yyyy = year), property of the request body.
description (string) – Condition description, property of the request body.
dictionary_name (string) – Dictionary name, property of the request body.
dictionary_value (string) – Dictionary value, property of the request body.
hours_range (object) – Defines for which hours a TimeAndDate condition will be matched Time format hh:mm ( h = hour , mm = minutes ) Default All Day , property of the request body.
hours_range_exception (object) – Defines for which hours a TimeAndDate condition will be matched Time format hh:mm ( h = hour , mm = minutes ) Default All Day , property of the request body.
id (string) – id, property of the request body.
is_negate (boolean) – Indicates whereas this condition is in negate mode, property of the request body.
link (object) – link, property of the request body.
name (basestring) – Condition name, property of the request body.
operator (string) – Equality operator, property of the request body. Available values are ‘contains’, ‘endsWith’, ‘equals’, ‘greaterOrEquals’, ‘greaterThan’, ‘in’, ‘ipEquals’, ‘ipGreaterThan’, ‘ipLessThan’, ‘ipNotEquals’, ‘lessOrEquals’, ‘lessThan’, ‘matches’, ‘notContains’, ‘notEndsWith’, ‘notEquals’, ‘notIn’, ‘notStartsWith’ and ‘startsWith’.
week_days (list) – Defines for which days this condition will be matched Days format Arrays of WeekDay enums Default List of All week days, property of the request body (list of strings. Available values are ‘Friday’, ‘Monday’, ‘Saturday’, ‘Sunday’, ‘Thursday’, ‘Tuesday’ and ‘Wednesday’).
week_days_exception (list) – Defines for which days this condition will NOT be matched Days format Arrays of WeekDay enums Default Not enabled, property of the request body (list of strings. Available values are ‘Friday’, ‘Monday’, ‘Saturday’, ‘Sunday’, ‘Thursday’, ‘Tuesday’ and ‘Wednesday’).
name – name path parameter. Condition name.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_name
(name, attribute_name=None, attribute_value=None, children=None, condition_type=None, dates_range=None, dates_range_exception=None, description=None, dictionary_name=None, dictionary_value=None, hours_range=None, hours_range_exception=None, id=None, is_negate=None, link=None, operator=None, week_days=None, week_days_exception=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_device_admin_condition_by_name
-
delete_device_admin_condition_by_name
(name, headers=None, **query_parameters)[source]¶ NDevice Admin Delete a library condition using condition Name.
- Parameters
name (basestring) – name path parameter. Condition name.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_name
(name, headers=None, **query_parameters)[source]¶ Alias for delete_device_admin_condition_by_name
-
get_device_admin_conditions_for_policy_sets
(headers=None, **query_parameters)[source]¶ Device Admin Returns list of library conditions for policy sets.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_device_admin_condition_by_id
(id, headers=None, **query_parameters)[source]¶ Device Admin Returns a library condition.
- Parameters
id (basestring) – id path parameter. Condition id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_device_admin_condition_by_id
-
update_device_admin_condition_by_id
(id, attribute_name=None, attribute_value=None, children=None, condition_type=None, dates_range=None, dates_range_exception=None, description=None, dictionary_name=None, dictionary_value=None, hours_range=None, hours_range_exception=None, is_negate=None, link=None, name=None, operator=None, week_days=None, week_days_exception=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Device Admin Update library condition.
- Parameters
attribute_name (string) – Dictionary attribute name, property of the request body.
attribute_value (string) – Attribute value for condition Value type is specified in dictionary object if multiple values allowed is specified in dictionary object, property of the request body.
children (list) – In case type is andBlock or orBlock addtional conditions will be aggregated under this logical (OR/AND) condition, property of the request body (list of objects).
condition_type (string) – Inidicates whether the record is the condition itself(data) or a logical(or,and) aggregation Data type enum(reference,single) indicates than “conditonId” OR “ConditionAttrs” fields should contain condition data but not both Logical aggreation(and,or) enum indicates that additional conditions are present under the children field, property of the request body. Available values are ‘ConditionAndBlock’, ‘ConditionAttributes’, ‘ConditionOrBlock’, ‘ConditionReference’, ‘LibraryConditionAndBlock’, ‘LibraryConditionAttributes’, ‘LibraryConditionOrBlock’ and ‘TimeAndDateCondition’.
dates_range (object) – Defines for which date/s TimeAndDate condition will be matched Options are Date range, for specific date, the same date should be used for start/end date Default no specific dates In order to reset the dates to have no specific dates Date format yyyy- mm-dd (MM = month, dd = day, yyyy = year), property of the request body.
dates_range_exception (object) – Defines for which date/s TimeAndDate condition will be matched Options are Date range, for specific date, the same date should be used for start/end date Default no specific dates In order to reset the dates to have no specific dates Date format yyyy- mm-dd (MM = month, dd = day, yyyy = year), property of the request body.
description (string) – Condition description, property of the request body.
dictionary_name (string) – Dictionary name, property of the request body.
dictionary_value (string) – Dictionary value, property of the request body.
hours_range (object) – Defines for which hours a TimeAndDate condition will be matched Time format hh:mm ( h = hour , mm = minutes ) Default All Day , property of the request body.
hours_range_exception (object) – Defines for which hours a TimeAndDate condition will be matched Time format hh:mm ( h = hour , mm = minutes ) Default All Day , property of the request body.
id (basestring) – id, property of the request body.
is_negate (boolean) – Indicates whereas this condition is in negate mode, property of the request body.
link (object) – link, property of the request body.
name (string) – Condition name, property of the request body.
operator (string) – Equality operator, property of the request body. Available values are ‘contains’, ‘endsWith’, ‘equals’, ‘greaterOrEquals’, ‘greaterThan’, ‘in’, ‘ipEquals’, ‘ipGreaterThan’, ‘ipLessThan’, ‘ipNotEquals’, ‘lessOrEquals’, ‘lessThan’, ‘matches’, ‘notContains’, ‘notEndsWith’, ‘notEquals’, ‘notIn’, ‘notStartsWith’ and ‘startsWith’.
week_days (list) – Defines for which days this condition will be matched Days format Arrays of WeekDay enums Default List of All week days, property of the request body (list of strings. Available values are ‘Friday’, ‘Monday’, ‘Saturday’, ‘Sunday’, ‘Thursday’, ‘Tuesday’ and ‘Wednesday’).
week_days_exception (list) – Defines for which days this condition will NOT be matched Days format Arrays of WeekDay enums Default Not enabled, property of the request body (list of strings. Available values are ‘Friday’, ‘Monday’, ‘Saturday’, ‘Sunday’, ‘Thursday’, ‘Tuesday’ and ‘Wednesday’).
id – id path parameter. Condition id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, attribute_name=None, attribute_value=None, children=None, condition_type=None, dates_range=None, dates_range_exception=None, description=None, dictionary_name=None, dictionary_value=None, hours_range=None, hours_range_exception=None, is_negate=None, link=None, name=None, operator=None, week_days=None, week_days_exception=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_device_admin_condition_by_id
-
delete_device_admin_condition_by_id
(id, headers=None, **query_parameters)[source]¶ Device Admin Delete a library condition.
- Parameters
id (basestring) – id path parameter. Condition id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_device_admin_condition_by_id
-
device_administration_dictionary_attributes_list¶
-
class
DeviceAdministrationDictionaryAttributesList
[source]¶ Identity Services Engine Device Administration - Dictionary Attributes List API (version: 3.1.0).
Wraps the Identity Services Engine Device Administration - Dictionary Attributes List API and exposes the API as native Python methods that return native Python objects.
-
get_device_admin_dictionaries_authentication
(headers=None, **query_parameters)[source]¶ Network Access Returns list of dictionary attributes for authentication.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
Network Access Returns list of dictionary attributes for authorization.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_device_admin_dictionaries_policy_set
(headers=None, **query_parameters)[source]¶ Network Access Returns list of dictionary attributes for policyset.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_policy_set
(headers=None, **query_parameters)[source]¶ Alias for get_device_admin_dictionaries_policy_set
-
device_administration_identity_stores¶
-
class
DeviceAdministrationIdentityStores
[source]¶ Identity Services Engine Device Administration - Identity Stores API (version: 3.1.0).
Wraps the Identity Services Engine Device Administration - Identity Stores API and exposes the API as native Python methods that return native Python objects.
-
get_device_admin_identity_stores
(headers=None, **query_parameters)[source]¶ Device Admin Return list of identity stores for authentication. (Other CRUD APIs available through ERS).
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(list): A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(headers=None, **query_parameters)[source]¶ Alias for get_device_admin_identity_stores
-
device_administration_network_conditions¶
-
class
DeviceAdministrationNetworkConditions
[source]¶ Identity Services Engine Device Administration - Network Conditions API (version: 3.1.0).
Wraps the Identity Services Engine Device Administration - Network Conditions API and exposes the API as native Python methods that return native Python objects.
-
get_device_admin_network_conditions
(headers=None, **query_parameters)[source]¶ Device Admin Returns a list of network conditions.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(headers=None, **query_parameters)[source]¶ Alias for get_device_admin_network_conditions
-
create_device_admin_network_condition
(condition_type=None, conditions=None, description=None, id=None, link=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Device AdminCreates network condition.
- Parameters
condition_type (string) – This field determines the content of the conditions field, property of the request body. Available values are ‘DeviceCondition’, ‘DevicePortCondition’ and ‘EndstationCondition’.
conditions (list) – conditions, property of the request body (list of objects).
description (string) – description, property of the request body.
id (string) – id, property of the request body.
link (object) – link, property of the request body.
name (string) – Network Condition name, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(condition_type=None, conditions=None, description=None, id=None, link=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_device_admin_network_condition
-
get_device_admin_network_condition_by_id
(id, headers=None, **query_parameters)[source]¶ Device Admin Returns a network condition.
- Parameters
id (basestring) – id path parameter. Condition id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_device_admin_network_condition_by_id
-
update_device_admin_network_condition_by_id
(id, condition_type=None, conditions=None, description=None, link=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Device Admin Update network condition.
- Parameters
condition_type (string) – This field determines the content of the conditions field, property of the request body. Available values are ‘DeviceCondition’, ‘DevicePortCondition’ and ‘EndstationCondition’.
conditions (list) – conditions, property of the request body (list of objects).
description (string) – description, property of the request body.
id (basestring) – id, property of the request body.
link (object) – link, property of the request body.
name (string) – Network Condition name, property of the request body.
id – id path parameter. Condition id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, condition_type=None, conditions=None, description=None, link=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
-
delete_device_admin_network_condition_by_id
(id, headers=None, **query_parameters)[source]¶ Device Admin Delete network condition.
- Parameters
id (basestring) – id path parameter. Condition id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
device_administration_policy_set¶
-
class
DeviceAdministrationPolicySet
[source]¶ Identity Services Engine Device Administration - Policy Set API (version: 3.1.0).
Wraps the Identity Services Engine Device Administration - Policy Set API and exposes the API as native Python methods that return native Python objects.
-
get_device_admin_policy_sets
(headers=None, **query_parameters)[source]¶ Device Admin List of policy sets.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(headers=None, **query_parameters)[source]¶ Alias for get_device_admin_policy_sets
-
create_device_admin_policy_set
(condition=None, default=None, description=None, hit_counts=None, id=None, is_proxy=None, link=None, name=None, rank=None, service_name=None, state=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Device Admin Create a new policy set: Policy must include name , service identifier (either server sequence or allowed protocol) and a condition. Condition has hierarchical structure which define a set of condition for which policy could be match. Condition can be either reference to a stored Library condition, using model ConditionReference , or, dynamically built conditions which are not stored in the conditions Library, using models ConditionAttributes, ConditionAndBlock, ConditionOrBlock . .
- Parameters
condition (object) – condition, property of the request body.
default (boolean) – Flag which indicates if this policy set is the default one, property of the request body.
description (string) – The description for the policy set, property of the request body.
hit_counts (integer) – The amount of times the policy was matched, property of the request body.
id (string) – Identifier for the policy set, property of the request body.
is_proxy (boolean) – Flag which indicates if the policy set service is of type ‘Proxy Sequence’ or ‘Allowed Protocols’, property of the request body.
link (object) – link, property of the request body.
name (string) – Given name for the policy set, [Valid characters are alphanumerics, underscore, hyphen, space, period, parentheses], property of the request body.
rank (integer) – The rank(priority) in relation to other policy set. Lower rank is higher priority., property of the request body.
service_name (string) – Policy set service identifier Allowed Protocols,Server Sequence.., property of the request body.
state (string) – The state that the policy set is in. A disabled policy set cannot be matched., property of the request body. Available values are ‘disabled’, ‘enabled’ and ‘monitor’.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(condition=None, default=None, description=None, hit_counts=None, id=None, is_proxy=None, link=None, name=None, rank=None, service_name=None, state=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_device_admin_policy_set
-
reset_hit_counts_device_admin_policy_sets
(headers=None, **query_parameters)[source]¶ Device Admin Reset HitCount for PolicySets.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_device_admin_policy_set_by_id
(id, headers=None, **query_parameters)[source]¶ Device Admin Get policy set attributes.
- Parameters
id (basestring) – id path parameter. Policy id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_device_admin_policy_set_by_id
-
update_device_admin_policy_set_by_id
(id, condition=None, default=None, description=None, hit_counts=None, is_proxy=None, link=None, name=None, rank=None, service_name=None, state=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Device Admin Update a policy set.
- Parameters
condition (object) – condition, property of the request body.
default (boolean) – Flag which indicates if this policy set is the default one, property of the request body.
description (string) – The description for the policy set, property of the request body.
hit_counts (integer) – The amount of times the policy was matched, property of the request body.
id (basestring) – Identifier for the policy set, property of the request body.
is_proxy (boolean) – Flag which indicates if the policy set service is of type ‘Proxy Sequence’ or ‘Allowed Protocols’, property of the request body.
link (object) – link, property of the request body.
name (string) – Given name for the policy set, [Valid characters are alphanumerics, underscore, hyphen, space, period, parentheses], property of the request body.
rank (integer) – The rank(priority) in relation to other policy set. Lower rank is higher priority., property of the request body.
service_name (string) – Policy set service identifier Allowed Protocols,Server Sequence.., property of the request body.
state (string) – The state that the policy set is in. A disabled policy set cannot be matched., property of the request body. Available values are ‘disabled’, ‘enabled’ and ‘monitor’.
id – id path parameter. Policy id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, condition=None, default=None, description=None, hit_counts=None, is_proxy=None, link=None, name=None, rank=None, service_name=None, state=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_device_admin_policy_set_by_id
-
delete_device_admin_policy_set_by_id
(id, headers=None, **query_parameters)[source]¶ Device Admin Delete a policy set.
- Parameters
id (basestring) – id path parameter. Policy id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_device_admin_policy_set_by_id
-
device_administration_profiles¶
-
class
DeviceAdministrationProfiles
[source]¶ Identity Services Engine Device Administration - Profiles API (version: 3.1.0).
Wraps the Identity Services Engine Device Administration - Profiles API and exposes the API as native Python methods that return native Python objects.
-
get_device_admin_profiles
(headers=None, **query_parameters)[source]¶ Device Admin Returns list of shell profiles. (Other CRUD APIs available through ERS).
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(list): A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(headers=None, **query_parameters)[source]¶ Alias for get_device_admin_profiles
-
device_administration_service_names¶
-
class
DeviceAdministrationServiceNames
[source]¶ Identity Services Engine Device Administration - Service Names API (version: 3.1.0).
Wraps the Identity Services Engine Device Administration - Service Names API and exposes the API as native Python methods that return native Python objects.
-
get_device_admin_service_names
(headers=None, **query_parameters)[source]¶ Returns list of Allowed Protocols and Server Sequences for Device Admin Policy Set results. ‘isLocalAuthorization’ property is available only for Network Access Policy Set results of type Server Sequence. (Other CRUD APIs available through ERS).
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(list): A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(headers=None, **query_parameters)[source]¶ Alias for get_device_admin_service_names
-
device_administration_time_date_conditions¶
-
class
DeviceAdministrationTimeDateConditions
[source]¶ Identity Services Engine Device Administration - Time/Date Conditions API (version: 3.1.0).
Wraps the Identity Services Engine Device Administration - Time/Date Conditions API and exposes the API as native Python methods that return native Python objects.
-
get_device_admin_time_conditions
(headers=None, **query_parameters)[source]¶ Device Admin Returns a list of time and date conditions.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(headers=None, **query_parameters)[source]¶ Alias for get_device_admin_time_conditions
-
create_device_admin_time_condition
(attribute_name=None, attribute_value=None, children=None, condition_type=None, dates_range=None, dates_range_exception=None, description=None, dictionary_name=None, dictionary_value=None, hours_range=None, hours_range_exception=None, id=None, is_negate=None, link=None, name=None, operator=None, week_days=None, week_days_exception=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Device Admin Creates time/date condition.
- Parameters
attribute_name (string) – Dictionary attribute name, property of the request body.
attribute_value (string) – Attribute value for condition Value type is specified in dictionary object if multiple values allowed is specified in dictionary object, property of the request body.
children (list) – In case type is andBlock or orBlock addtional conditions will be aggregated under this logical (OR/AND) condition, property of the request body (list of objects).
condition_type (string) – Inidicates whether the record is the condition itself(data) or a logical(or,and) aggregation Data type enum(reference,single) indicates than “conditonId” OR “ConditionAttrs” fields should contain condition data but not both Logical aggreation(and,or) enum indicates that additional conditions are present under the children field, property of the request body. Available values are ‘ConditionAndBlock’, ‘ConditionAttributes’, ‘ConditionOrBlock’, ‘ConditionReference’, ‘LibraryConditionAndBlock’, ‘LibraryConditionAttributes’, ‘LibraryConditionOrBlock’ and ‘TimeAndDateCondition’.
dates_range (object) – Defines for which date/s TimeAndDate condition will be matched Options are Date range, for specific date, the same date should be used for start/end date Default no specific dates In order to reset the dates to have no specific dates Date format yyyy- mm-dd (MM = month, dd = day, yyyy = year), property of the request body.
dates_range_exception (object) – Defines for which date/s TimeAndDate condition will be matched Options are Date range, for specific date, the same date should be used for start/end date Default no specific dates In order to reset the dates to have no specific dates Date format yyyy- mm-dd (MM = month, dd = day, yyyy = year), property of the request body.
description (string) – Condition description, property of the request body.
dictionary_name (string) – Dictionary name, property of the request body.
dictionary_value (string) – Dictionary value, property of the request body.
hours_range (object) – Defines for which hours a TimeAndDate condition will be matched Time format hh:mm ( h = hour , mm = minutes ) Default All Day , property of the request body.
hours_range_exception (object) – Defines for which hours a TimeAndDate condition will be matched Time format hh:mm ( h = hour , mm = minutes ) Default All Day , property of the request body.
id (string) – id, property of the request body.
is_negate (boolean) – Indicates whereas this condition is in negate mode, property of the request body.
link (object) – link, property of the request body.
name (string) – Condition name, property of the request body.
operator (string) – Equality operator, property of the request body. Available values are ‘contains’, ‘endsWith’, ‘equals’, ‘greaterOrEquals’, ‘greaterThan’, ‘in’, ‘ipEquals’, ‘ipGreaterThan’, ‘ipLessThan’, ‘ipNotEquals’, ‘lessOrEquals’, ‘lessThan’, ‘matches’, ‘notContains’, ‘notEndsWith’, ‘notEquals’, ‘notIn’, ‘notStartsWith’ and ‘startsWith’.
week_days (list) – Defines for which days this condition will be matched Days format Arrays of WeekDay enums Default List of All week days, property of the request body (list of strings. Available values are ‘Friday’, ‘Monday’, ‘Saturday’, ‘Sunday’, ‘Thursday’, ‘Tuesday’ and ‘Wednesday’).
week_days_exception (list) – Defines for which days this condition will NOT be matched Days format Arrays of WeekDay enums Default Not enabled, property of the request body (list of strings. Available values are ‘Friday’, ‘Monday’, ‘Saturday’, ‘Sunday’, ‘Thursday’, ‘Tuesday’ and ‘Wednesday’).
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(attribute_name=None, attribute_value=None, children=None, condition_type=None, dates_range=None, dates_range_exception=None, description=None, dictionary_name=None, dictionary_value=None, hours_range=None, hours_range_exception=None, id=None, is_negate=None, link=None, name=None, operator=None, week_days=None, week_days_exception=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_device_admin_time_condition
-
get_device_admin_time_condition_by_id
(id, headers=None, **query_parameters)[source]¶ Device Admin Returns a network condition.
- Parameters
id (basestring) – id path parameter. Condition id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_device_admin_time_condition_by_id
-
update_device_admin_time_condition_by_id
(id, attribute_name=None, attribute_value=None, children=None, condition_type=None, dates_range=None, dates_range_exception=None, description=None, dictionary_name=None, dictionary_value=None, hours_range=None, hours_range_exception=None, is_negate=None, link=None, name=None, operator=None, week_days=None, week_days_exception=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Device Admin Update network condition.
- Parameters
attribute_name (string) – Dictionary attribute name, property of the request body.
attribute_value (string) – Attribute value for condition Value type is specified in dictionary object if multiple values allowed is specified in dictionary object, property of the request body.
children (list) – In case type is andBlock or orBlock addtional conditions will be aggregated under this logical (OR/AND) condition, property of the request body (list of objects).
condition_type (string) – Inidicates whether the record is the condition itself(data) or a logical(or,and) aggregation Data type enum(reference,single) indicates than “conditonId” OR “ConditionAttrs” fields should contain condition data but not both Logical aggreation(and,or) enum indicates that additional conditions are present under the children field, property of the request body. Available values are ‘ConditionAndBlock’, ‘ConditionAttributes’, ‘ConditionOrBlock’, ‘ConditionReference’, ‘LibraryConditionAndBlock’, ‘LibraryConditionAttributes’, ‘LibraryConditionOrBlock’ and ‘TimeAndDateCondition’.
dates_range (object) – Defines for which date/s TimeAndDate condition will be matched Options are Date range, for specific date, the same date should be used for start/end date Default no specific dates In order to reset the dates to have no specific dates Date format yyyy- mm-dd (MM = month, dd = day, yyyy = year), property of the request body.
dates_range_exception (object) – Defines for which date/s TimeAndDate condition will be matched Options are Date range, for specific date, the same date should be used for start/end date Default no specific dates In order to reset the dates to have no specific dates Date format yyyy- mm-dd (MM = month, dd = day, yyyy = year), property of the request body.
description (string) – Condition description, property of the request body.
dictionary_name (string) – Dictionary name, property of the request body.
dictionary_value (string) – Dictionary value, property of the request body.
hours_range (object) – Defines for which hours a TimeAndDate condition will be matched Time format hh:mm ( h = hour , mm = minutes ) Default All Day , property of the request body.
hours_range_exception (object) – Defines for which hours a TimeAndDate condition will be matched Time format hh:mm ( h = hour , mm = minutes ) Default All Day , property of the request body.
id (basestring) – id, property of the request body.
is_negate (boolean) – Indicates whereas this condition is in negate mode, property of the request body.
link (object) – link, property of the request body.
name (string) – Condition name, property of the request body.
operator (string) – Equality operator, property of the request body. Available values are ‘contains’, ‘endsWith’, ‘equals’, ‘greaterOrEquals’, ‘greaterThan’, ‘in’, ‘ipEquals’, ‘ipGreaterThan’, ‘ipLessThan’, ‘ipNotEquals’, ‘lessOrEquals’, ‘lessThan’, ‘matches’, ‘notContains’, ‘notEndsWith’, ‘notEquals’, ‘notIn’, ‘notStartsWith’ and ‘startsWith’.
week_days (list) – Defines for which days this condition will be matched Days format Arrays of WeekDay enums Default List of All week days, property of the request body (list of strings. Available values are ‘Friday’, ‘Monday’, ‘Saturday’, ‘Sunday’, ‘Thursday’, ‘Tuesday’ and ‘Wednesday’).
week_days_exception (list) – Defines for which days this condition will NOT be matched Days format Arrays of WeekDay enums Default Not enabled, property of the request body (list of strings. Available values are ‘Friday’, ‘Monday’, ‘Saturday’, ‘Sunday’, ‘Thursday’, ‘Tuesday’ and ‘Wednesday’).
id – id path parameter. Condition id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, attribute_name=None, attribute_value=None, children=None, condition_type=None, dates_range=None, dates_range_exception=None, description=None, dictionary_name=None, dictionary_value=None, hours_range=None, hours_range_exception=None, is_negate=None, link=None, name=None, operator=None, week_days=None, week_days_exception=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_device_admin_time_condition_by_id
-
delete_device_admin_time_condition_by_id
(id, headers=None, **query_parameters)[source]¶ Device Admin Delete Time/Date condition.
- Parameters
id (basestring) – id path parameter. Condition id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_device_admin_time_condition_by_id
-
downloadable_acl¶
-
class
DownloadableAcl
[source]¶ Identity Services Engine DownloadableACL API (version: 3.1.0).
Wraps the Identity Services Engine DownloadableACL API and exposes the API as native Python methods that return native Python objects.
Downloadable ACL API allows the client to add, delete, update, search and perform actions on downloadable ACL.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
Revision Modification
Revision Modification
Attribute
Description
0
1.0
2.3
Initial Cisco ISE Version
1
1.1
2.6
Support new attribute IP version in 2.6
daclType
Added Enum Attribute ‘daclType’
Resource Definition
Attribute
Type
Required
Description
Default Values
Example Values
name
String
Yes
Resource Name. Name may contain alphanumeric or any of the following characters [_.-]
multiline_acl
id
String
Yes
Resource UUID
c1e0e9e0-717f-11eb-9fb2-b6cb23d38630
description
String
No
Use the string n for a newline
description
dacl
String
Yes
The DACL Content. Use the string n for a newline
permit ip any any
daclType
Enum
No
Allowed values: IPV4, IPV6, IP_AGNOSTIC
IPV4
-
get_downloadable_acl_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get a downloadable ACL by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_downloadable_acl_by_id
-
update_downloadable_acl_by_id
(id, dacl=None, dacl_type=None, description=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update a downloadable ACL.
- Parameters
dacl (string) – The DACL Content. Use the string n for a newline, property of the request body.
dacl_type (string) – Allowed values: IPV4, IPV6, IP_AGNOSTIC, property of the request body.
description (string) – Use the string n for a newline, property of the request body.
id (basestring) – id, property of the request body.
name (string) – Resource Name. Name may contain alphanumeric or any of the following characters [_.-], property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, dacl=None, dacl_type=None, description=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_downloadable_acl_by_id
-
delete_downloadable_acl_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes a downloadable ACL.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_downloadable_acl_by_id
-
get_downloadable_acl
(page=None, size=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all downloadable ACLs.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_downloadable_acl
-
get_downloadable_acl_generator
(page=None, size=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all downloadable ACLs.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_downloadable_acl_generator
-
create_downloadable_acl
(dacl=None, dacl_type=None, description=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates a downloadable ACL.
- Parameters
dacl (string) – The DACL Content. Use the string n for a newline, property of the request body.
dacl_type (string) – Allowed values: IPV4, IPV6, IP_AGNOSTIC, property of the request body.
description (string) – Use the string n for a newline, property of the request body.
name (string) – Resource Name. Name may contain alphanumeric or any of the following characters [_.-], property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(dacl=None, dacl_type=None, description=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_downloadable_acl
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the downloadable ACL.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
egress_matrix_cell¶
-
class
EgressMatrixCell
[source]¶ Identity Services Engine EgressMatrixCell API (version: 3.1.0).
Wraps the Identity Services Engine EgressMatrixCell API and exposes the API as native Python methods that return native Python objects.
Egress Policy Matrix Cell API allows the client to add, update, delete and search egress matrix cells among other operations.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.0
Initial Cisco ISE Version
1
1.1
2.3
Introducing bulk operations
Resource Definition
Attribute
Type
Required
Description
Default Values
Example Values
name
String
Yes
Resource Name
ANY-ANY
id
String
No
Resource UUID, mandatory for update
f92c1a900-8c01-11e6-996c-525400b48521
description
String
No
Default egress rule
defaultRule
Enum
Yes
Allowed values: NONE, DENY_IP, PERMIT_IP
NONE
PERMIT_IP
destinationSgtId
String
Yes
92bb1950-8c01-11e6-996c-525400b48521
matrixCellStatus
Enum
Yes
Allowed values: DISABLED, ENABLED, MONITOR
DISABLED
ENABLED
sgACLs
List
Yes
[“92951ac0-8c01-11e6-996c-525400b48521”]
sourceSgtId
String
Yes
92bb1950-8c01-11e6-996c-525400b48521
-
clear_all_matrix_cells
(headers=None, **query_parameters)[source]¶ This API allows the client to clear all the egress matrix cells.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
clear
(headers=None, **query_parameters)[source]¶ Alias for clear_all_matrix_cells
-
set_all_cells_status
(status, headers=None, **query_parameters)[source]¶ his API allows the client to set status of all the egress matrix cells.
- Parameters
status (basestring) – status path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
set_status
(status, headers=None, **query_parameters)[source]¶ Alias for set_all_cells_status
-
clone_matrix_cell
(dst_sgt_id, id, src_sgt_id, headers=None, **query_parameters)[source]¶ This API allows the client to clone an egress matrix cell.
- Parameters
id (basestring) – id path parameter.
src_sgt_id (basestring) – srcSgtId path parameter.
dst_sgt_id (basestring) – dstSgtId path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
clone
(dst_sgt_id, id, src_sgt_id, headers=None, **query_parameters)[source]¶ Alias for clone_matrix_cell
-
get_egress_matrix_cell_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get an egress matrix cell by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_egress_matrix_cell_by_id
-
update_egress_matrix_cell_by_id
(id, default_rule=None, description=None, destination_sgt_id=None, matrix_cell_status=None, name=None, sgacls=None, source_sgt_id=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update an egress matrix cell.
- Parameters
default_rule (string) – Allowed values: NONE, DENY_IP, PERMIT_IP, property of the request body.
description (string) – description, property of the request body.
destination_sgt_id (string) – destinationSgtId, property of the request body.
id (basestring) – id, property of the request body.
matrix_cell_status (string) – Allowed values: DISABLED, ENABLED, MONITOR, property of the request body.
name (string) – name, property of the request body.
sgacls (list) – sgacls, property of the request body (list of strings).
source_sgt_id (string) – sourceSgtId, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, default_rule=None, description=None, destination_sgt_id=None, matrix_cell_status=None, name=None, sgacls=None, source_sgt_id=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_egress_matrix_cell_by_id
-
delete_egress_matrix_cell_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes an egress matrix cell.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_egress_matrix_cell_by_id
-
get_egress_matrix_cell
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the egress matrix cell. Filter: [sgtSrcValue, matrixStatus, description, sgtSrcName, sgtDstName, sgtDstValue] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [description, sgtSrcName, sgtDstName, sgtDstValue].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_egress_matrix_cell
-
get_egress_matrix_cell_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the egress matrix cell. Filter: [sgtSrcValue, matrixStatus, description, sgtSrcName, sgtDstName, sgtDstValue] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [description, sgtSrcName, sgtDstName, sgtDstValue].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_egress_matrix_cell_generator
-
create_egress_matrix_cell
(default_rule=None, description=None, destination_sgt_id=None, matrix_cell_status=None, name=None, sgacls=None, source_sgt_id=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates an egress matrix cell.
- Parameters
default_rule (string) – Allowed values: NONE, DENY_IP, PERMIT_IP, property of the request body.
description (string) – description, property of the request body.
destination_sgt_id (string) – destinationSgtId, property of the request body.
matrix_cell_status (string) – Allowed values: DISABLED, ENABLED, MONITOR, property of the request body.
name (string) – name, property of the request body.
sgacls (list) – sgacls, property of the request body (list of strings).
source_sgt_id (string) – sourceSgtId, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(default_rule=None, description=None, destination_sgt_id=None, matrix_cell_status=None, name=None, sgacls=None, source_sgt_id=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_egress_matrix_cell
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the egress matrix cell.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
bulk_request_for_egress_matrix_cell
(operation_type=None, resource_media_type=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to submit the bulk request.
- Parameters
operation_type (string) – operationType, property of the request body.
resource_media_type (string) – resourceMediaType, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
bulk_request
(operation_type=None, resource_media_type=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for bulk_request_for_egress_matrix_cell
-
monitor_bulk_status_egress_matrix_cell
(bulkid, headers=None, **query_parameters)[source]¶ This API allows the client to monitor the bulk request.
- Parameters
bulkid (basestring) – bulkid path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
monitor_bulk_status
(bulkid, headers=None, **query_parameters)[source]¶ Alias for monitor_bulk_status_egress_matrix_cell
-
endpoint_certificate¶
-
class
EndpointCertificate
[source]¶ Identity Services Engine EndpointCertificate API (version: 3.1.0).
Wraps the Identity Services Engine EndpointCertificate API and exposes the API as native Python methods that return native Python objects.
Endpoint Certificate API allows the client to create endpoint certificates signed by the Cisco ISE Internal CA. This API can takes in certificate request details, create a RSA key pair, create a certificate and return the resulting key pair and certificate as a ZIP file. ZIP files are returned as an octet stream.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.0
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Example Values
name
String
Yes
Resource Name
id
String
No
Resource UUID, mandatory for update
description
String
No
certTemplateName
String
Yes
Name of an Internal CA template
Certificate_Template_Name
format
Enum
Yes
Allowed values: PKCS12, PKCS12_CHAIN, PKCS8, PKCS8_CHAIN
PKCS8
password
String
Yes
Protects the private key. Must have more than 8 characters, less than 15 characters, at least one upper case letter, at least one lower case letter, at least one digit, and can only contain [A-Z][a-z][0-9]_#
Password_123
certificateRequest
Map
Yes
Key value map. Must have CN and SAN entries
CN
String
Yes
Matches the requester’s User Name, unless the Requester is an ERS Admin. ERS Admins are allowed to create requests for any CN
userName [or] machineName
SAN
String
Yes
Valid MAC Address, delimited by ‘-’
11-22-33-44-55-66
-
create_endpoint_certificate
(cert_template_name=None, certificate_request=None, format=None, password=None, dirpath=None, save_file=None, filename=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to create an endpoint certificate.
- Parameters
cert_template_name (string) – Name of an Internal CA template, property of the request body.
certificate_request (object) – Key value map. Must have CN and SAN entries, property of the request body.
format (string) – Allowed values: PKCS12, PKCS12_CHAIN, PKCS8, PKCS8_CHAIN, property of the request body.
password (string) – Protects the private key. Must have more than 8 characters, less than 15 characters, at least one upper case letter, at least one lower case letter, at least one digit, and can only contain [A-Z][a-z][0-9]_#, property of the request body.
dirpath (basestring) – Directory absolute path. Defaults to os.getcwd().
save_file (bool) – Enable or disable automatic file creation of raw response.
filename (basestring) – The filename used to save the download file.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
The DownloadResponse wrapper. Wraps the urllib3.response.HTTPResponse. For more information check the urlib3 documentation
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
DownloadFailure – If was not able to download the raw
response to a file. –
-
create
(cert_template_name=None, certificate_request=None, format=None, password=None, dirpath=None, save_file=None, filename=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_endpoint_certificate
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the endpoint certificate.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
endpoint_identity_group¶
-
class
EndpointIdentityGroup
[source]¶ Identity Services Engine EndpointIdentityGroup API (version: 3.1.0).
Wraps the Identity Services Engine EndpointIdentityGroup API and exposes the API as native Python methods that return native Python objects.
Endpoint Identity Groups API allows the client to add, delete, update, and search endpoint groups.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
1.3
Initial Cisco ISE Version
1
1.1
2.4
Added GetByName operation
Resource Definition
Attribute
Type
Required
Description
Default Values
Example Values
name
String
Yes
Resource Name
Cisco-Meraki-Devicee
id
String
No
Resource UUID, mandatory for update
1e2700a0-8c00-11e6-996c-525400b48521
description
String
No
Identity Group for Profile: Cisco-Meraki-Device
systemDefined
Boolean
Yes
false
true
-
get_endpoint_group_by_name
(name, headers=None, **query_parameters)[source]¶ This API allows the client to get an endpoint identity group by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_name
(name, headers=None, **query_parameters)[source]¶ Alias for get_endpoint_group_by_name
-
get_endpoint_group_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get an endpoint identity group by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_endpoint_group_by_id
-
update_endpoint_group_by_id
(id, description=None, name=None, system_defined=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update an endpoint identity group.
- Parameters
description (string) – description, property of the request body.
id (basestring) – id, property of the request body.
name (string) – name, property of the request body.
system_defined (boolean) – systemDefined, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, description=None, name=None, system_defined=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_endpoint_group_by_id
-
delete_endpoint_group_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes an endpoint identity group.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_endpoint_group_by_id
-
get_endpoint_groups
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the endpoint identity groups. Filter: [name] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_endpoint_groups
-
get_endpoint_groups_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the endpoint identity groups. Filter: [name] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_endpoint_groups_generator
-
create_endpoint_group
(description=None, name=None, system_defined=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates an endpoint identity group.
- Parameters
description (string) – description, property of the request body.
name (string) – name, property of the request body.
system_defined (boolean) – systemDefined, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(description=None, name=None, system_defined=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_endpoint_group
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the endpoint identity group.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
external_radius_server¶
-
class
ExternalRadiusServer
[source]¶ Identity Services Engine ExternalRADIUSServer API (version: 3.1.0).
Wraps the Identity Services Engine ExternalRADIUSServer API and exposes the API as native Python methods that return native Python objects.
External RADIUS Server API allows the client to add, delete, update, search and perform actions on external RADIUS server.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
Revision Modification
Revision Modification
Attribute
Description
0
1.0
2.3
Initial Cisco ISE Version
1
1.1
2.6
Support new attribute Proxy Dead Timeout
proxyTimeout
Added int Attribute ‘proxyTimeout’
Resource Definition
Attribute
Type
Required
Description
Default Values
Example Values
name
String
Yes
Resource Name. Allowed charactera are alphanumeric and _ (underscore).
externalRadiusServer1
id
String
No
Resource UUID, mandatory for update
da095377-dce8-486e-933a-6ea788bbf51a
description
String
No
example external radius server
hostIP
String
Yes
The IP of the host - must be a valid IPV4 address
1.1.1.1
sharedSecret
String
Yes
Shared secret maximum length is 128 characters
sharedSecret
enableKeyWrap
Boolean
Yes
KeyWrap may only be enabled if it is supported on the device. When running in FIPS mode this option should be enabled for such devices
true
encryptionKey
String
No
The encryptionKey is required only if enableKeyWrap is true, otherwise it must be ignored or empty. The maximum length is 16 ASCII characters or 32 HEXADECIMAL characters (depend on selection in field ‘keyInputFormat’)
1616161616161616
authenticatorKey
String
No
The authenticatorKey is required only if enableKeyWrap is true, otherwise it must be ignored or empty. The maximum length is 20 ASCII characters or 40 HEXADECIMAL characters (depend on selection in field ‘keyInputFormat’)
20202020202020202020
keyInputFormat
Enum
Yes
Specifies the format of the input for fields ‘encryptionKey’ and ‘authenticatorKey’. Allowed Values: ASCII, HEXADECIMAL
ASCII
authenticationPort
Integer
Yes
Valid Range 1 to 65535
1812
accountingPort
Integer
Yes
Valid Range 1 to 65535
1813
timeout
Integer
Yes
Valid Range 1 to 120
5
retries
Integer
Yes
Valid Range 1 to 9
3
proxyTimeout
Integer
No
Valid Range 1 to 600
300
-
get_external_radius_server_by_name
(name, headers=None, **query_parameters)[source]¶ This API allows the client to get an external RADIUS server by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_name
(name, headers=None, **query_parameters)[source]¶ Alias for get_external_radius_server_by_name
-
get_external_radius_server_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get an external RADIUS server by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_external_radius_server_by_id
-
update_external_radius_server_by_id
(id, accounting_port=None, authentication_port=None, authenticator_key=None, description=None, enable_key_wrap=None, encryption_key=None, host_ip=None, key_input_format=None, name=None, proxy_timeout=None, retries=None, shared_secret=None, timeout=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update an external RADIUS server.
- Parameters
accounting_port (integer) – Valid Range 1 to 65535, property of the request body.
authentication_port (integer) – Valid Range 1 to 65535, property of the request body.
authenticator_key (string) – The authenticatorKey is required only if enableKeyWrap is true, otherwise it must be ignored or empty. The maximum length is 20 ASCII characters or 40 HEXADECIMAL characters (depend on selection in field ‘keyInputFormat’), property of the request body.
description (string) – description, property of the request body.
enable_key_wrap (boolean) – KeyWrap may only be enabled if it is supported on the device. When running in FIPS mode this option should be enabled for such devices, property of the request body.
encryption_key (string) – The encryptionKey is required only if enableKeyWrap is true, otherwise it must be ignored or empty. The maximum length is 16 ASCII characters or 32 HEXADECIMAL characters (depend on selection in field ‘keyInputFormat’), property of the request body.
host_ip (string) – The IP of the host must be a valid IPV4 address, property of the request body.
id (basestring) – id, property of the request body.
key_input_format (string) – Specifies the format of the input for fields ‘encryptionKey’ and ‘authenticatorKey’. Allowed Values: ASCII HEXADECIMAL, property of the request body.
name (string) – Resource Name. Allowed charactera are alphanumeric and _ (underscore)., property of the request body.
proxy_timeout (integer) – Valid Range 1 to 600, property of the request body.
retries (integer) – Valid Range 1 to 9, property of the request body.
shared_secret (string) – Shared secret maximum length is 128 characters, property of the request body.
timeout (integer) – Valid Range 1 to 120, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, accounting_port=None, authentication_port=None, authenticator_key=None, description=None, enable_key_wrap=None, encryption_key=None, host_ip=None, key_input_format=None, name=None, proxy_timeout=None, retries=None, shared_secret=None, timeout=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_external_radius_server_by_id
-
delete_external_radius_server_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes an external RADIUS server.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_external_radius_server_by_id
-
get_external_radius_server
(page=None, size=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the external RADIUS servers.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_external_radius_server
-
get_external_radius_server_generator
(page=None, size=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the external RADIUS servers.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_external_radius_server_generator
-
create_external_radius_server
(accounting_port=None, authentication_port=None, authenticator_key=None, description=None, enable_key_wrap=None, encryption_key=None, host_ip=None, key_input_format=None, name=None, proxy_timeout=None, retries=None, shared_secret=None, timeout=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates an external RADIUS server.
- Parameters
accounting_port (integer) – Valid Range 1 to 65535, property of the request body.
authentication_port (integer) – Valid Range 1 to 65535, property of the request body.
authenticator_key (string) – The authenticatorKey is required only if enableKeyWrap is true, otherwise it must be ignored or empty. The maximum length is 20 ASCII characters or 40 HEXADECIMAL characters (depend on selection in field ‘keyInputFormat’), property of the request body.
description (string) – description, property of the request body.
enable_key_wrap (boolean) – KeyWrap may only be enabled if it is supported on the device. When running in FIPS mode this option should be enabled for such devices, property of the request body.
encryption_key (string) – The encryptionKey is required only if enableKeyWrap is true, otherwise it must be ignored or empty. The maximum length is 16 ASCII characters or 32 HEXADECIMAL characters (depend on selection in field ‘keyInputFormat’), property of the request body.
host_ip (string) – The IP of the host must be a valid IPV4 address, property of the request body.
key_input_format (string) – Specifies the format of the input for fields ‘encryptionKey’ and ‘authenticatorKey’. Allowed Values: ASCII HEXADECIMAL, property of the request body.
name (string) – Resource Name. Allowed charactera are alphanumeric and _ (underscore)., property of the request body.
proxy_timeout (integer) – Valid Range 1 to 600, property of the request body.
retries (integer) – Valid Range 1 to 9, property of the request body.
shared_secret (string) – Shared secret maximum length is 128 characters, property of the request body.
timeout (integer) – Valid Range 1 to 120, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(accounting_port=None, authentication_port=None, authenticator_key=None, description=None, enable_key_wrap=None, encryption_key=None, host_ip=None, key_input_format=None, name=None, proxy_timeout=None, retries=None, shared_secret=None, timeout=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_external_radius_server
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the external RADIUS server.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
filter_policy¶
-
class
FilterPolicy
[source]¶ Identity Services Engine FilterPolicy API (version: 3.1.0).
Wraps the Identity Services Engine FilterPolicy API and exposes the API as native Python methods that return native Python objects.
Filter Policy API allows clients to add, get, update and delete SXP domain filter policies.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
3.0
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Example Values
name
String
Yes
Resource Name
id
String
No
Resource UUID, mandatory for update
description
String
No
subnet
String
No
Subnet for filter policy (hostname is not supported). At least one of subnet or sgt or vn should be defined
subnetAddress
sgt
String
No
SGT name or ID. At least one of subnet or sgt or vn should be defined
sgt
vn
String
No
Virtual Network. At least one of subnet or sgt or vn should be defined
virtualNetwork
domains
String
Yes
List of SXP Domains, separated with comma
Sxp Vpn Name
-
get_filter_policy_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get a filter policy by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_filter_policy_by_id
-
update_filter_policy_by_id
(id, domains=None, sgt=None, subnet=None, vn=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update a filter policy.
- Parameters
domains (string) – List of SXP Domains, separated with comma, property of the request body.
sgt (string) – SGT name or ID. At least one of subnet or sgt or vn should be defined, property of the request body.
subnet (string) – Subnet for filter policy (hostname is not supported). At least one of subnet or sgt or vn should be defined, property of the request body.
vn (string) – Virtual Network. At least one of subnet or sgt or vn should be defined, property of the request body.
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, domains=None, sgt=None, subnet=None, vn=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_filter_policy_by_id
-
delete_filter_policy_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes a filter policy.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_filter_policy_by_id
-
get_filter_policy
(page=None, size=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the filter policies.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_filter_policy
-
get_filter_policy_generator
(page=None, size=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the filter policies.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_filter_policy_generator
-
create_filter_policy
(domains=None, sgt=None, subnet=None, vn=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates a filter policy.
- Parameters
domains (string) – List of SXP Domains, separated with comma, property of the request body.
sgt (string) – SGT name or ID. At least one of subnet or sgt or vn should be defined, property of the request body.
subnet (string) – Subnet for filter policy (hostname is not supported). At least one of subnet or sgt or vn should be defined, property of the request body.
vn (string) – Virtual Network. At least one of subnet or sgt or vn should be defined, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(domains=None, sgt=None, subnet=None, vn=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_filter_policy
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the filter policy.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
guest_location¶
-
class
GuestLocation
[source]¶ Identity Services Engine GuestLocation API (version: 3.1.0).
Wraps the Identity Services Engine GuestLocation API and exposes the API as native Python methods that return native Python objects.
Guest Location API allows the client to search the locations configured from Cisco ISE GUI.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.2
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Example Values
name
String
Yes
Resource Name
name
id
String
No
Resource UUID, mandatory for update
9f083530-8c01-11e6-996c-525400b48521
description
String
No
-
get_guest_location_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get a guest location by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_guest_location_by_id
-
get_guest_location
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the guest locations. Filter: [name] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_guest_location
-
get_guest_location_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the guest locations. Filter: [name] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_guest_location_generator
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the guest location.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
guest_smtp_notification_configuration¶
-
class
GuestSmtpNotificationConfiguration
[source]¶ Identity Services Engine GuestSMTPNotificationConfiguration API (version: 3.1.0).
Wraps the Identity Services Engine GuestSMTPNotificationConfiguration API and exposes the API as native Python methods that return native Python objects.
Guest SMTP notification configuration API is a global setting for enabling email notifications within guest application. These APIs allow to create, update and retrieve the notification settings. The create API may not be required to be used as of Cisco ISE Release 2.2 because the single SMTP notification configuration is the only one used and it always gets created during the Cisco ISE application initialization period.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.2
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Default Values
Example Values
name
String
Yes
Resource Name
id
String
No
Resource UUID, mandatory for update
9ecb5340-8c01-11e6-996c-525400b48521
description
String
No
defaultFromAddress
String
No
The default from email address to be used to send emails from
notificationEnabled
Boolean
No
Indicates if the email notification service is to be enabled
true
smtpServer
String
No
The SMTP server ip address or fqdn such as outbound.mycompany.com
useDefaultFromAddress
Boolean
No
If the default from address should be used rather than using a sponsor user email address
false
smtpPort
String
No
Port at which SMTP Secure Server is listening
25
connectionTimeout
String
No
Interval in seconds for all the SMTP client connections
60
useTLSorSSLEncryption
Boolean
No
If configured to true, SMTP server authentication will happen using TLS/SSL
false
usePasswordAuthentication
Boolean
No
If configured to true, SMTP server authentication will happen using username/password
false
userName
String
No
Username of Secure SMTP server
password
String
No
Password of Secure SMTP server
-
get_guest_smtp_notification_settings_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get a guest SMTP notification configuration by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_guest_smtp_notification_settings_by_id
(id, connection_timeout=None, default_from_address=None, notification_enabled=None, password=None, smtp_port=None, smtp_server=None, use_default_from_address=None, use_password_authentication=None, use_tlsor_ssl_encryption=None, user_name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update a SMTP configuration setting.
- Parameters
connection_timeout (string) – Interval in seconds for all the SMTP client connections, property of the request body.
default_from_address (string) – The default from email address to be used to send emails from, property of the request body.
id (basestring) – id, property of the request body.
notification_enabled (boolean) – Indicates if the email notification service is to be enabled, property of the request body.
password (string) – Password of Secure SMTP server, property of the request body.
smtp_port (string) – Port at which SMTP Secure Server is listening, property of the request body.
smtp_server (string) – The SMTP server ip address or fqdn such as outbound.mycompany.com, property of the request body.
use_default_from_address (boolean) – If the default from address should be used rather than using a sponsor user email address, property of the request body.
use_password_authentication (boolean) – If configured to true, SMTP server authentication will happen using username/password, property of the request body.
use_tlsor_ssl_encryption (boolean) – If configured to true, SMTP server authentication will happen using TLS/SSL, property of the request body.
user_name (string) – Username of Secure SMTP server, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, connection_timeout=None, default_from_address=None, notification_enabled=None, password=None, smtp_port=None, smtp_server=None, use_default_from_address=None, use_password_authentication=None, use_tlsor_ssl_encryption=None, user_name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
-
get_guest_smtp_notification_settings
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the guest SMTP notification configurations. Filter: [name] To search guest users by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_guest_smtp_notification_settings
-
get_guest_smtp_notification_settings_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the guest SMTP notification configurations. Filter: [name] To search guest users by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶
-
create_guest_smtp_notification_settings
(connection_timeout=None, default_from_address=None, notification_enabled=None, password=None, smtp_port=None, smtp_server=None, use_default_from_address=None, use_password_authentication=None, use_tlsor_ssl_encryption=None, user_name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates a guest SMTP notification configuration.
- Parameters
connection_timeout (string) – Interval in seconds for all the SMTP client connections, property of the request body.
default_from_address (string) – The default from email address to be used to send emails from, property of the request body.
notification_enabled (boolean) – Indicates if the email notification service is to be enabled, property of the request body.
password (string) – Password of Secure SMTP server, property of the request body.
smtp_port (string) – Port at which SMTP Secure Server is listening, property of the request body.
smtp_server (string) – The SMTP server ip address or fqdn such as outbound.mycompany.com, property of the request body.
use_default_from_address (boolean) – If the default from address should be used rather than using a sponsor user email address, property of the request body.
use_password_authentication (boolean) – If configured to true, SMTP server authentication will happen using username/password, property of the request body.
use_tlsor_ssl_encryption (boolean) – If configured to true, SMTP server authentication will happen using TLS/SSL, property of the request body.
user_name (string) – Username of Secure SMTP server, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(connection_timeout=None, default_from_address=None, notification_enabled=None, password=None, smtp_port=None, smtp_server=None, use_default_from_address=None, use_password_authentication=None, use_tlsor_ssl_encryption=None, user_name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_guest_smtp_notification_settings
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the guest smtp notification configuration.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
guest_ssid¶
-
class
GuestSsid
[source]¶ Identity Services Engine GuestSSID API (version: 3.1.0).
Wraps the Identity Services Engine GuestSSID API and exposes the API as native Python methods that return native Python objects.
Guest SSIDs are global objects that are referenced by Cisco ISE sponsor portals. Guest SSID API allows the client to add, delete, update and search guest SSID among other operations which are available from all the portals.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.2
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Example Values
name
String
Yes
Resource Name. Name may contain alphanumeric or any of the following characters [_.-]
ssid_value
id
String
No
Resource UUID, mandatory for update
9132eedc-7910-4ffe-805e-3d3a366f7fb7
description
String
No
-
get_guest_ssid_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get a guest SSID by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_guest_ssid_by_id
-
update_guest_ssid_by_id
(id, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update a guest SSID by ID.
- Parameters
id (basestring) – id, property of the request body.
name (string) – Resource Name. Name may contain alphanumeric or any of the following characters [_.-], property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_guest_ssid_by_id
-
delete_guest_ssid_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes a guest SSID by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_guest_ssid_by_id
-
get_guest_ssid
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the guest SSIDs. Filter: [name] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_guest_ssid
-
get_guest_ssid_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the guest SSIDs. Filter: [name] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_guest_ssid_generator
-
create_guest_ssid
(name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates a guest SSID.
- Parameters
name (string) – Resource Name. Name may contain alphanumeric or any of the following characters [_.-], property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_guest_ssid
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the guest SSID.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
guest_type¶
-
class
GuestType
[source]¶ Identity Services Engine GuestType API (version: 3.1.0).
Wraps the Identity Services Engine GuestType API and exposes the API as native Python methods that return native Python objects.
Guest Type API allows the client to add, delete, update and search guest types.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.2
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Default Values
Example Values
name
String
Yes
Resource Name
Contractor (default)
id
String
No
Resource UUID, mandatory for update
9f03a151-8c01-11e6-996c-525400b48521
description
String
No
Default settings allow network access for up to a year.
accessTime
List
No
allowAccessOnSpecificDaysTimes
Boolean
No
Enable Specific Day Time Limits
false
defaultDuration
Integer
No
90
durationTimeUnit
Enum
No
Allowed values are: - DAYS, - HOURS, - MINUTES
DAYS
fromFirstLogin
Boolean
No
When Account Duration starts from first login or specified date
false
maxAccountDuration
Integer
No
Maximum value of Account Duration
365
dayTimeLimits
List
No
List of Time Ranges for account access
dayTimeLimit
List
No
Time Ranges for account access
startTime
String
No
Start time in HH:mm format
09:00
endTime
String
No
End time in HH:mm format
17:00
days
List
No
List of Days
day
Enum
No
Value should be one of Week day. Allowed values are: - Sunday, - Monday, - Tuesday, - Wednesday, - Thursday, - Friday, - Saturday
loginOptions
List
No
Login options
allowGuestPortalBypass
Boolean
No
false
failureAction
Enum
No
When Guest Exceeds limit this action will be invoked, Allowed values are: - Disconnect_Oldest_Connection, - Disconnect_Newest_Connection
Disconnect_Oldest_Connection
identityGroupId
String
Yes
ID of Guest Identity Group
aa178bd0-8bff-11e6-996c-525400b48521
limitSimultaneousLogins
Boolean
No
Enable Simultaneous Logins
true
maxRegisteredDevices
Integer
No
Maximum devices guests can register
5
maxSimultaneousLogins
Integer
No
Number of Simultaneous Logins
3
expirationNotification
List
No
Expiration Notification Settings
advanceNotificationDuration
Integer
No
Send Account Expiration Notification Duration before ( Days, Hours, Minutes )
3
advanceNotificationUnits
Enum
No
Allowed values are: - DAYS, - HOURS, - MINUTES
DAYS
enableNotification
Boolean
No
Enable Notification settings
false
sendEmailNotification
Boolean
No
Enable Email Notification
false
sendSmsNotification
Integer
No
Maximum devices guests can register
5
sponsorGroups
List
Yes
List of Sponsor Groups
[“GROUP_ACCOUNTS (default)”, “ALL_ACCOUNTS (default)”, “OWN_ACCOUNTS (default)”]
-
update_guest_type_email
(id, additional_data=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update a guest type email by ID.
- Parameters
additional_data (list) – additionalData, property of the request body (list of objects).
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_email
(id, additional_data=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_guest_type_email
-
update_guest_type_sms
(id, additional_data=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update a guest type sms by ID.
- Parameters
additional_data (list) – additionalData, property of the request body (list of objects).
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_sms
(id, additional_data=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_guest_type_sms
-
get_guest_type_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get a guest type by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_guest_type_by_id
-
update_guest_type_by_id
(id, access_time=None, description=None, expiration_notification=None, is_default_type=None, login_options=None, name=None, sponsor_groups=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update a guest type.
- Parameters
access_time (object) – accessTime, property of the request body.
description (string) – description, property of the request body.
expiration_notification (object) – Expiration Notification Settings, property of the request body.
id (basestring) – id, property of the request body.
is_default_type (boolean) – isDefaultType, property of the request body.
login_options (object) – loginOptions, property of the request body.
name (string) – name, property of the request body.
sponsor_groups (list) – sponsorGroups, property of the request body (list of strings).
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, access_time=None, description=None, expiration_notification=None, is_default_type=None, login_options=None, name=None, sponsor_groups=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_guest_type_by_id
-
delete_guest_type_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes a guest type.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_guest_type_by_id
-
get_guest_type
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the guest types. Filter: [name] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_guest_type
-
get_guest_type_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the guest types. Filter: [name] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_guest_type_generator
-
create_guest_type
(access_time=None, description=None, expiration_notification=None, is_default_type=None, login_options=None, name=None, sponsor_groups=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates a guest type.
- Parameters
access_time (object) – accessTime, property of the request body.
description (string) – description, property of the request body.
expiration_notification (object) – Expiration Notification Settings, property of the request body.
is_default_type (boolean) – isDefaultType, property of the request body.
login_options (object) – loginOptions, property of the request body.
name (string) – name, property of the request body.
sponsor_groups (list) – sponsorGroups, property of the request body (list of strings).
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(access_time=None, description=None, expiration_notification=None, is_default_type=None, login_options=None, name=None, sponsor_groups=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_guest_type
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the guest type.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
guest_user¶
-
class
GuestUser
[source]¶ Identity Services Engine GuestUser API (version: 3.1.0).
Wraps the Identity Services Engine GuestUser API and exposes the API as native Python methods that return native Python objects.
Guest User API allows the client to add, delete, update and search guest users among other operations which are available from the sponsor portal. Please note that each API description shows whether the API is supported in bulk operation. The bulk section is showing only ‘create’ bulk operation. However, all other operation which are bulk supported can be used in the same way.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
1.2
Initial Cisco ISE Version
1
2.0
1.3
Introducing new schema - not supporting 1.0 anymore
Resource Definition
Attribute
Type
Required
Description
Default Values
Example Values
name
String
Yes
Resource Name
guestUser
id
String
No
Resource UUID, mandatory for update
ab6deded-fcc2-47ff-8577-0014737c8fcf
description
String
No
ERS Example user
customFields
Map
No
Key value map
“some key” : “some value”
guestType
String
No
Contractor
status
String
No
reasonForVisit
String
No
personBeingVisited
String
No
sponsorUserName
String
No
Mr Spons
sponsorUserId
String
No
statusReason
String
No
portalId
String
No
23423432523
guestAccessInfo
List
No
validDays
Integer
Yes
Number of days guest user is valid. To validate validDays property, Cisco ISE considers only date (not time) between fromDate and toDate properites
90
fromDate
String
No
07/29/2014 14:44
toDate
String
No
10/29/2014 17:30
location
String
No
San Jose
ssid
String
No
groupTag
String
No
GuestInfo
List
Yes
emailAddress
String
No
enabled
Boolean
Yes
This field is only for Get operation not applicable for Create, Update operations
false
password
String
Yes
asdlkj324ew
phoneNumber
String
No
Phone number should be E.164 format
+13211239034
smsServiceProvider
String
No
Global Default
userName
String
No
If account needs be created with mobile number, please provide mobile number here
DS3ewdsa34wWE
firstName
String
No
lastName
String
No
company
String
No
creationTime
String
No
notificationLanguage
String
No
-
approve_guest_user_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to approve a guest user by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
approve_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for approve_guest_user_by_id
-
change_sponsor_password
(portal_id, additional_data=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to change the sponsor password.
- Parameters
additional_data (list) – additionalData, property of the request body (list of objects).
portal_id (basestring) – portalId path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
suspend_guest_user_by_name
(name, headers=None, **query_parameters)[source]¶ This API allows the client to suspend a guest user by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
suspend_by_name
(name, headers=None, **query_parameters)[source]¶ Alias for suspend_guest_user_by_name
-
reinstate_guest_user_by_name
(name, headers=None, **query_parameters)[source]¶ This API allows the client to reinstate a guest user by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
reinstate_by_name
(name, headers=None, **query_parameters)[source]¶ Alias for reinstate_guest_user_by_name
-
get_guest_user_by_name
(name, headers=None, **query_parameters)[source]¶ This API allows the client to get a guest user by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_name
(name, headers=None, **query_parameters)[source]¶ Alias for get_guest_user_by_name
-
update_guest_user_by_name
(name, custom_fields=None, description=None, guest_access_info=None, guest_info=None, guest_type=None, id=None, portal_id=None, reason_for_visit=None, sponsor_user_id=None, sponsor_user_name=None, status=None, status_reason=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update a guest user by name.
- Parameters
custom_fields (object) – Key value map, property of the request body.
description (string) – description, property of the request body.
guest_access_info (object) – guestAccessInfo, property of the request body.
guest_info (object) – guestInfo, property of the request body.
guest_type (string) – guestType, property of the request body.
id (string) – id, property of the request body.
name (basestring) – name, property of the request body.
portal_id (string) – portalId, property of the request body.
reason_for_visit (string) – reasonForVisit, property of the request body.
sponsor_user_id (string) – sponsorUserId, property of the request body.
sponsor_user_name (string) – sponsorUserName, property of the request body.
status (string) – status, property of the request body.
status_reason (string) – statusReason, property of the request body.
name – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_name
(name, custom_fields=None, description=None, guest_access_info=None, guest_info=None, guest_type=None, id=None, portal_id=None, reason_for_visit=None, sponsor_user_id=None, sponsor_user_name=None, status=None, status_reason=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_guest_user_by_name
-
delete_guest_user_by_name
(name, headers=None, **query_parameters)[source]¶ This API deletes a guest user.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_name
(name, headers=None, **query_parameters)[source]¶ Alias for delete_guest_user_by_name
-
reset_guest_user_password_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to reset the guest user password.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
reset_password_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for reset_guest_user_password_by_id
-
reinstate_guest_user_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to reinstate a guest user by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
reinstate_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for reinstate_guest_user_by_id
-
update_guest_user_email
(id, portal_id, additional_data=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update a guest user email by ID.
- Parameters
additional_data (list) – additionalData, property of the request body (list of objects).
id (basestring) – id path parameter.
portal_id (basestring) – portalId path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_email
(id, portal_id, additional_data=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_guest_user_email
-
update_guest_user_sms
(id, portal_id, headers=None, **query_parameters)[source]¶ This API allows the client to update a guest user sms by ID.
- Parameters
id (basestring) – id path parameter.
portal_id (basestring) – portalId path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_sms
(id, portal_id, headers=None, **query_parameters)[source]¶ Alias for update_guest_user_sms
-
deny_guest_user_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to deny a guest user by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
deny_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for deny_guest_user_by_id
-
get_guest_user_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get a guest user by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_guest_user_by_id
-
update_guest_user_by_id
(id, custom_fields=None, description=None, guest_access_info=None, guest_info=None, guest_type=None, name=None, portal_id=None, reason_for_visit=None, sponsor_user_id=None, sponsor_user_name=None, status=None, status_reason=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update a guest user by ID.
- Parameters
custom_fields (object) – Key value map, property of the request body.
description (string) – description, property of the request body.
guest_access_info (object) – guestAccessInfo, property of the request body.
guest_info (object) – guestInfo, property of the request body.
guest_type (string) – guestType, property of the request body.
id (basestring) – id, property of the request body.
name (string) – name, property of the request body.
portal_id (string) – portalId, property of the request body.
reason_for_visit (string) – reasonForVisit, property of the request body.
sponsor_user_id (string) – sponsorUserId, property of the request body.
sponsor_user_name (string) – sponsorUserName, property of the request body.
status (string) – status, property of the request body.
status_reason (string) – statusReason, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, custom_fields=None, description=None, guest_access_info=None, guest_info=None, guest_type=None, name=None, portal_id=None, reason_for_visit=None, sponsor_user_id=None, sponsor_user_name=None, status=None, status_reason=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_guest_user_by_id
-
delete_guest_user_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes a guest user by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_guest_user_by_id
-
get_guest_users
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the guest users. Filter: [lastName, sponsor, creationTime, personBeingVisited, toDate, userName, firstName, emailAddress, phoneNumber, groupTag, name, company, guestType, status] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [firstName, lastName, emailAddress, name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_guest_users
-
get_guest_users_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the guest users. Filter: [lastName, sponsor, creationTime, personBeingVisited, toDate, userName, firstName, emailAddress, phoneNumber, groupTag, name, company, guestType, status] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [firstName, lastName, emailAddress, name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_guest_users_generator
-
create_guest_user
(custom_fields=None, description=None, guest_access_info=None, guest_info=None, guest_type=None, name=None, portal_id=None, reason_for_visit=None, sponsor_user_id=None, sponsor_user_name=None, status=None, status_reason=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates a guest user.
- Parameters
custom_fields (object) – Key value map, property of the request body.
description (string) – description, property of the request body.
guest_access_info (object) – guestAccessInfo, property of the request body.
guest_info (object) – guestInfo, property of the request body.
guest_type (string) – guestType, property of the request body.
name (string) – name, property of the request body.
portal_id (string) – portalId, property of the request body.
reason_for_visit (string) – reasonForVisit, property of the request body.
sponsor_user_id (string) – sponsorUserId, property of the request body.
sponsor_user_name (string) – sponsorUserName, property of the request body.
status (string) – status, property of the request body.
status_reason (string) – statusReason, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(custom_fields=None, description=None, guest_access_info=None, guest_info=None, guest_type=None, name=None, portal_id=None, reason_for_visit=None, sponsor_user_id=None, sponsor_user_name=None, status=None, status_reason=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_guest_user
-
suspend_guest_user_by_id
(id, additional_data=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to suspend a guest user by ID.
- Parameters
additional_data (list) – additionalData, property of the request body (list of objects).
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
suspend_by_id
(id, additional_data=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for suspend_guest_user_by_id
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the guest user.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
bulk_request_for_guest_user
(operation_type=None, resource_media_type=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to submit the bulk request.
- Parameters
operation_type (string) – operationType, property of the request body.
resource_media_type (string) – resourceMediaType, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
bulk_request
(operation_type=None, resource_media_type=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for bulk_request_for_guest_user
-
monitor_bulk_status_guest_user
(bulkid, headers=None, **query_parameters)[source]¶ This API allows the client to monitor the bulk request.
- Parameters
bulkid (basestring) – bulkid path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
monitor_bulk_status
(bulkid, headers=None, **query_parameters)[source]¶ Alias for monitor_bulk_status_guest_user
hotspot_portal¶
-
class
HotspotPortal
[source]¶ Identity Services Engine HotspotPortal API (version: 3.1.0).
Wraps the Identity Services Engine HotspotPortal API and exposes the API as native Python methods that return native Python objects.
Hotspot Guest Portal API provides the ability to create, read, update, delete and search hotspot guest portals.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.2
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Default Values
Example Values
name
String
Yes
Resource Name
Hotspot Guest Portal (default)
id
String
No
Resource UUID, mandatory for update
b132a9ef-1491-4e01-9ad4-b48a9c72e1c7
description
String
No
Guests do not require username and password credentials to access the network, but you can optionally require an access code
portalTestUrl
String
No
URL to bring up a test page for this portal
https://{ise-ip}:8443/portal/PortalSetup.action?portal=b132a9ef-1491-4e01-9ad4-b48a9c72e1c7
portalType
Enum
Yes
Allowed values: BYOD, HOTSPOTGUEST, MYDEVICE, SELFREGGUEST, SPONSOR, SPONSOREDGUEST
HOTSPOTGUEST
settings
List
No
Defines all of the settings groups available for a BYOD
portalSettings
List
No
The port, interface, certificate, and other basic settings of a portal
httpsPort
Integer
Yes
The port number that the allowed interfaces will listen on. Range from 8000 to 8999
8443
allowedInterfaces
Enum
Yes
Interfaces that the portal will be reachable on. Allowed values: eth0, eth1, eth2, eth3, eth4, eth5, bond0, bond1, bond2
[ “eth0”, “bond0” ]
certificateGroupTag
String
Yes
Logical name of the x.509 server certificate that will be used for the portal
Default Portal Certificate Group
endpointIdentityGroup
String
Yes
Unique Id of the endpoint identity group where user’s devices will be added. Used only in Hotspot Portal
aa178bd0-8bff-11e6-996c-525400b48521
displayLang
Enum
No
Allowed values: USEBROWSERLOCALE, ALWAYSUSE
USEBROWSERLOCALE
fallbackLanguage
String
No
Used when displayLang = USEBROWSERLOCALE
English
alwaysUsedLanguage
String
No
Used when displayLang = ALWAYSUSE
English
coaType
Enum
No
Allowed Values: COAREAUTHENTICATE, COATERMINATE
COAREAUTHENTICATE
aupSettings
List
No
Configuration of the Acceptable Use Policy (AUP) for a portal
requireAccessCode
Boolean
No
Require the portal user to enter an access code. Only used in Hotspot portal
false
accessCode
String
No
Access code that must be entered by the portal user (only valid if requireAccessCode = true)
includeAup
Boolean
No
Require the portal user to read and accept an AUP
true
requireScrolling
Boolean
No
Require the portal user to scroll to the end of the AUP. Only valid if requireAupAcceptance = true
false
authSuccessSettings
List
No
successRedirect
Enum
No
After an Authentication Success where should device be redirected. Allowed values: AUTHSUCCESSPAGE, ORIGINATINGURL, URL
AUTHSUCCESSPAGE
redirectUrl
String
No
Target URL for redirection, used when successRedirect = URL
www.cisco.com
postLoginBannerSettings
List
No
includePostAccessBanner
Boolean
No
Include a Post-Login Banner page
false
supportInfoSettings
List
No
Portal Support Information Settings
includeSupportInfoPage
Boolean
No
false
includeMacAddr
Boolean
No
false
includeIpAddress
Boolean
No
false
includeBrowserUserAgent
Boolean
No
false
includePolicyServer
Boolean
No
false
includeFailureCode
Boolean
No
false
emptyFieldDisplay
Enum
No
Specifies how empty fields are handled on the Support Information Page. Allowed values: HIDE, DISPLAYWITHNOVALUE, DISPLAYWITHDEFAULTVALUE
HIDE
defaultEmptyFieldValue
String
No
The default value displayed for an empty field Only valid when emptyFieldDisplay = DISPLAYWITHDEFAULTVALUE
customizations
List
No
Defines all of the Portal Customizations available
portalTheme
List
No
Defines the configuration for portal theme
id
String
No
The unique internal identifier of the portal theme
9eb421c0-8c01-11e6-996c-525400b48521
name
String
Yes
The system- or user-assigned name of the portal theme
Default Blue theme
themeData
String
No
A CSS file, represented as a Base64-encoded byte array
Base 64 encoded string of Theme CSS file
portalTweakSettings
List
No
The Tweak Settings are a customization of the Portal Theme that has been selected for the portal. When the Portal Theme selection is changed, the Tweak Settings are overwritten to match the values in the theme. The Tweak Settings can subsequently be changed by the user
bannerColor
String
No
Hex value of color
#0000FF
bannerTextColor
String
No
Banner Text color code from GUI
pageBackgroundColor
String
No
Color code from GUI
pageLabelAndTextColor
String
No
Label and Text color from GUI
language
List
No
This property is supported only for Read operation and it allows to show the customizations in English. Other languages are not supported
viewLanguage
String
No
English
globalCustomizations
List
No
Represent the portal Global customizations
bannerTitle
String
No
BYOD Portal
contactText
String
No
Contact Support
footerElement
String
No
Footer Element
mobileLogoImage
Image
No
data
String
No
Represented as base 64 encoded string of the image byte array
base 64 encoded value of image
desktopLogoImage
Image
No
data
String
No
Represented as base 64 encoded string of the image byte array
base 64 encoded value of image
bannerImage
Image
No
data
String
No
Represented as base 64 encoded string of the image byte array
base 64 encoded value of image
backgroundImage
Image
No
data
String
No
Represented as base 64 encoded string of the image byte array
base 64 encoded value of image
pageCustomizations
List
No
Represent the entire page customization as a giant dictionary
data
List
No
The Dictionary will be exposed here as key value pair
key
String
Yes
ui_contact_ip_address_label
value
String
Yes
SVAgYWRkcmVzczo=
-
get_hotspot_portal_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get a hotspot portal by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_hotspot_portal_by_id
-
update_hotspot_portal_by_id
(id, customizations=None, description=None, name=None, portal_test_url=None, portal_type=None, settings=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update a hotspot portal by ID.
- Parameters
customizations (object) – Defines all of the Portal Customizations available, property of the request body.
description (string) – description, property of the request body.
id (basestring) – id, property of the request body.
name (string) – name, property of the request body.
portal_test_url (string) – URL to bring up a test page for this portal, property of the request body.
portal_type (string) – Allowed values: BYOD, HOTSPOTGUEST, MYDEVICE, SELFREGGUEST, SPONSOR, SPONSOREDGUEST, property of the request body.
settings (object) – Defines all of the settings groups available for a BYOD, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, customizations=None, description=None, name=None, portal_test_url=None, portal_type=None, settings=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_hotspot_portal_by_id
-
delete_hotspot_portal_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes a hotspot portal by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_hotspot_portal_by_id
-
get_hotspot_portal
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the hotspot portals. Filter: [name] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_hotspot_portal
-
get_hotspot_portal_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the hotspot portals. Filter: [name] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_hotspot_portal_generator
-
create_hotspot_portal
(customizations=None, description=None, name=None, portal_test_url=None, portal_type=None, settings=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates a hotspot portal.
- Parameters
customizations (object) – Defines all of the Portal Customizations available, property of the request body.
description (string) – description, property of the request body.
name (string) – name, property of the request body.
portal_test_url (string) – URL to bring up a test page for this portal, property of the request body.
portal_type (string) – Allowed values: BYOD, HOTSPOTGUEST, MYDEVICE, SELFREGGUEST, SPONSOR, SPONSOREDGUEST, property of the request body.
settings (object) – Defines all of the settings groups available for a BYOD, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(customizations=None, description=None, name=None, portal_test_url=None, portal_type=None, settings=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_hotspot_portal
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the hotspot portal.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
ip_to_sgt_mapping¶
-
class
IpToSgtMapping
[source]¶ Identity Services Engine IPToSGTMapping API (version: 3.1.0).
Wraps the Identity Services Engine IPToSGTMapping API and exposes the API as native Python methods that return native Python objects.
IP To SGT Mapping API allows the client to add, delete, update, search and deploy IP to SGT mapping.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.0
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Example Values
name
String
Yes
Resource Name
server1.cisco.com
id
String
No
Resource UUID, mandatory for update
description
String
No
deployTo
String
Mandatory unless mappingGroup is set or unless deployType=ALL
network_device_id
deployType
Enum
Yes
Allowed values: ALL, ND, NDG
ND
hostName
String
Mandatory if hostIp is empty
server1.cisco.com
sgt
String
Mandatory unless mappingGroup is set
sgt_id
hostIp
String
Mandatory if hostName is empty – valid IPL
mappingGroup
String
Mandatory unless sgt and deployTo and deployType are set
-
deploy_ip_to_sgt_mapping_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to deploy an IP to SGT mapping by ID. Only one Deploy process can run at any given time.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
deploy_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for deploy_ip_to_sgt_mapping_by_id
-
deploy_all_ip_to_sgt_mapping
(headers=None, **query_parameters)[source]¶ This API allows the client to deploy all the IP to SGT mappings. Only one Deploy process can run at any given time.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
deploy_all
(headers=None, **query_parameters)[source]¶ Alias for deploy_all_ip_to_sgt_mapping
-
get_deploy_status_ip_to_sgt_mapping
(headers=None, **query_parameters)[source]¶ This API allows the client to get the IP to SGT mapping deployment status. Deploy Status will show last Deploy command output. The information will be saved until the next Deploy command.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_deploy_status
(headers=None, **query_parameters)[source]¶ Alias for get_deploy_status_ip_to_sgt_mapping
-
get_ip_to_sgt_mapping_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get an IP to SGT mapping by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_ip_to_sgt_mapping_by_id
-
update_ip_to_sgt_mapping_by_id
(id, deploy_to=None, deploy_type=None, host_ip=None, host_name=None, mapping_group=None, name=None, sgt=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update an IP to SGT mapping by ID.
- Parameters
deploy_to (string) – Mandatory unless mappingGroup is set or unless deployType=ALL, property of the request body.
deploy_type (string) – Allowed values: ALL, ND, NDG, property of the request body.
host_ip (string) – Mandatory if hostName is empty -valid IP, property of the request body.
host_name (string) – Mandatory if hostIp is empty, property of the request body.
id (basestring) – id, property of the request body.
mapping_group (string) – Mapping Group Id. Mandatory unless sgt and deployTo and deployType are set, property of the request body.
name (string) – name, property of the request body.
sgt (string) – Mandatory unless mappingGroup is set, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, deploy_to=None, deploy_type=None, host_ip=None, host_name=None, mapping_group=None, name=None, sgt=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_ip_to_sgt_mapping_by_id
-
delete_ip_to_sgt_mapping_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes an IP to SGT mapping.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_ip_to_sgt_mapping_by_id
-
get_ip_to_sgt_mapping
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the IP to SGT mappings. Filter: [hostName, groupName, ip, sgtName] To search guest users by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [hostName, groupName, ip, sgtName].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_ip_to_sgt_mapping
-
get_ip_to_sgt_mapping_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the IP to SGT mappings. Filter: [hostName, groupName, ip, sgtName] To search guest users by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [hostName, groupName, ip, sgtName].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_ip_to_sgt_mapping_generator
-
create_ip_to_sgt_mapping
(deploy_to=None, deploy_type=None, host_ip=None, host_name=None, mapping_group=None, name=None, sgt=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates an IP to SGT mapping.
- Parameters
deploy_to (string) – Mandatory unless mappingGroup is set or unless deployType=ALL, property of the request body.
deploy_type (string) – Allowed values: ALL, ND, NDG, property of the request body.
host_ip (string) – Mandatory if hostName is empty -valid IP, property of the request body.
host_name (string) – Mandatory if hostIp is empty, property of the request body.
mapping_group (string) – Mapping Group Id. Mandatory unless sgt and deployTo and deployType are set, property of the request body.
name (string) – name, property of the request body.
sgt (string) – Mandatory unless mappingGroup is set, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(deploy_to=None, deploy_type=None, host_ip=None, host_name=None, mapping_group=None, name=None, sgt=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_ip_to_sgt_mapping
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to IP to SGT mapping.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
bulk_request_for_ip_to_sgt_mapping
(operation_type=None, resource_media_type=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to submit the bulk request.
- Parameters
operation_type (string) – operationType, property of the request body.
resource_media_type (string) – resourceMediaType, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
bulk_request
(operation_type=None, resource_media_type=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for bulk_request_for_ip_to_sgt_mapping
-
monitor_bulk_status_ip_to_sgt_mapping
(bulkid, headers=None, **query_parameters)[source]¶ This API allows the client to monitor the bulk request.
- Parameters
bulkid (basestring) – bulkid path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
monitor_bulk_status
(bulkid, headers=None, **query_parameters)[source]¶ Alias for monitor_bulk_status_ip_to_sgt_mapping
-
ip_to_sgt_mapping_group¶
-
class
IpToSgtMappingGroup
[source]¶ Identity Services Engine IPToSGTMappingGroup API (version: 3.1.0).
Wraps the Identity Services Engine IPToSGTMappingGroup API and exposes the API as native Python methods that return native Python objects.
IP To SGT Mapping Group API allows the client to add, delete, update, search and deploy IP to SGT mapping groups.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.0
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Default Values
Example Values
name
String
Yes
Resource Name
groupA
id
String
No
Resource UUID, mandatory for update
description
String
No
deployTo
String
Mandatory unless mappingGroup is set or unless deployType=ALL
network_device_id
deployType
Enum
Yes
Allowed values: ALL, ND, NDG
ALL
sgt
String
Mandatory unless mappingGroup is set
sgt_id
-
deploy_ip_to_sgt_mapping_group_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to deploy an IP to SGT mapping group by ID. Only one Deploy process can run at any given time.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
deploy_all_ip_to_sgt_mapping_group
(headers=None, **query_parameters)[source]¶ This API allows the client to deploy all the IP to SGT mapping groups. Only one Deploy process can run at any given time.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_deploy_status_ip_to_sgt_mapping_group
(headers=None, **query_parameters)[source]¶ This API allows the client to get the IP to SGT mapping group deployment status. Deploy Status will show last Deploy command output. The information will be saved until the next Deploy command.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_ip_to_sgt_mapping_group_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get an IP to SGT mapping group by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_ip_to_sgt_mapping_group_by_id
-
update_ip_to_sgt_mapping_group_by_id
(id, deploy_to=None, deploy_type=None, name=None, sgt=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update an IP to SGT mapping group by ID.
- Parameters
deploy_to (string) – Mandatory unless mappingGroup is set or unless deployType=ALL, property of the request body.
deploy_type (string) – Allowed values: ALL, ND, NDG, property of the request body.
name (string) – name, property of the request body.
sgt (string) – Mandatory unless mappingGroup is set, property of the request body.
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, deploy_to=None, deploy_type=None, name=None, sgt=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_ip_to_sgt_mapping_group_by_id
-
delete_ip_to_sgt_mapping_group_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes an IP to SGT mapping group.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_ip_to_sgt_mapping_group_by_id
-
get_ip_to_sgt_mapping_group
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the IP to SGT mapping groups. Filter: [name, sgtName] To search guest users by using toDate column,follow the format: DD- MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, sgtName].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_ip_to_sgt_mapping_group
-
get_ip_to_sgt_mapping_group_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the IP to SGT mapping groups. Filter: [name, sgtName] To search guest users by using toDate column,follow the format: DD- MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, sgtName].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_ip_to_sgt_mapping_group_generator
-
create_ip_to_sgt_mapping_group
(deploy_to=None, deploy_type=None, name=None, sgt=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates an IP to SGT mapping group.
- Parameters
deploy_to (string) – Mandatory unless mappingGroup is set or unless deployType=ALL, property of the request body.
deploy_type (string) – Allowed values: ALL, ND, NDG, property of the request body.
name (string) – name, property of the request body.
sgt (string) – Mandatory unless mappingGroup is set, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(deploy_to=None, deploy_type=None, name=None, sgt=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_ip_to_sgt_mapping_group
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the IP to SGT mapping group.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
bulk_request_for_ip_to_sgt_mapping_group
(operation_type=None, resource_media_type=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to submit the bulk request.
- Parameters
operation_type (string) – operationType, property of the request body.
resource_media_type (string) – resourceMediaType, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
bulk_request
(operation_type=None, resource_media_type=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for bulk_request_for_ip_to_sgt_mapping_group
-
monitor_bulk_status_ip_to_sgt_mapping_group
(bulkid, headers=None, **query_parameters)[source]¶ This API allows the client to monitor the bulk request.
- Parameters
bulkid (basestring) – bulkid path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
identity_groups¶
-
class
IdentityGroups
[source]¶ Identity Services Engine IdentityGroups API (version: 3.1.0).
Wraps the Identity Services Engine IdentityGroups API and exposes the API as native Python methods that return native Python objects.
Identity Groups API allows the client to search identity groups.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.2
Initial Cisco ISE Version
1
1.1
2.4
Added Create and GetByName operations
Resource Definition
Attribute
Type
Required
Description
Example Values
name
String
Yes
Resource Name
GuestType_Weekly (default)
id
String
No
Resource UUID, mandatory for update
9efe2310-8c01-11e6-996c-525400b48521
description
String
No
Identity group mirroring the guest type
parent
String
Yes
NAC Group:NAC:IdentityGroups:User Identity Groups
-
get_identity_group_by_name
(name, headers=None, **query_parameters)[source]¶ This API allows the client to get an identity group by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_name
(name, headers=None, **query_parameters)[source]¶ Alias for get_identity_group_by_name
-
get_identity_group_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get an identity group by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_identity_group_by_id
-
update_identity_group_by_id
(id, description=None, name=None, parent=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update an identity group.
- Parameters
description (string) – description, property of the request body.
id (basestring) – id, property of the request body.
name (string) – name, property of the request body.
parent (string) – parent, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, description=None, name=None, parent=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_identity_group_by_id
-
get_identity_groups
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the identity groups. Filter: [name, description] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_identity_groups
-
get_identity_groups_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the identity groups. Filter: [name, description] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_identity_groups_generator
-
create_identity_group
(description=None, name=None, parent=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates an identity group.
- Parameters
description (string) – description, property of the request body.
name (string) – name, property of the request body.
parent (string) – parent, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(description=None, name=None, parent=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_identity_group
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to identity group.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
identity_sequence¶
-
class
IdentitySequence
[source]¶ Identity Services Engine IdentitySequence API (version: 3.1.0).
Wraps the Identity Services Engine IdentitySequence API and exposes the API as native Python methods that return native Python objects.
Identity Sequence API allows the client to add, delete, update and search Identity sequences.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.2
Initial Cisco ISE Version
1
1.1
2.4
Added GetByName operation
Resource Definition
Attribute
Type
Required
Description
Example Values
name
String
Yes
Resource Name
All_User_ID_Stores
id
String
No
Resource UUID, mandatory for update
93246270-8c01-11e6-996c-525400b48521
description
String
No
A built-in Identity Sequence to include all User Identity Stores
breakOnStoreFail
Boolean
Yes
Do not access other stores in the sequence If a selected identity store cannot be accessed for authentication
false
certificateAuthenticationProfile
String
Yes
Certificate Authentication Profile, empty if doesn’t exist
Preloaded_Certificate_Profile
idSeqItem
List
Yes
List of id stores comprised of id store name and order
[ { “idstore”: “Internal Users”, “order”: 1 }, { “idstore”: “All_AD_Join_Points”, “order”: 2 }, { “idstore”: “Guest Users”, “order”: 3 } ]
-
get_identity_sequence_by_name
(name, headers=None, **query_parameters)[source]¶ This API allows the client to get an identity sequence by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_name
(name, headers=None, **query_parameters)[source]¶ Alias for get_identity_sequence_by_name
-
get_identity_sequence_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get an identity sequence by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_identity_sequence_by_id
-
update_identity_sequence_by_id
(id, break_on_store_fail=None, certificate_authentication_profile=None, description=None, id_seq_item=None, name=None, parent=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update an identity sequence. Partial update is not supported.
- Parameters
break_on_store_fail (boolean) – breakOnStoreFail, property of the request body.
certificate_authentication_profile (string) – certificateAuthenticationProfile, property of the request body.
description (string) – description, property of the request body.
id (basestring) – id, property of the request body.
id_seq_item (list) – idSeqItem, property of the request body (list of objects).
name (string) – name, property of the request body.
parent (string) – parent, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, break_on_store_fail=None, certificate_authentication_profile=None, description=None, id_seq_item=None, name=None, parent=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_identity_sequence_by_id
-
delete_identity_sequence_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes an identity sequence.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_identity_sequence_by_id
-
get_identity_sequence
(page=None, size=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the identity sequences.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_identity_sequence
-
get_identity_sequence_generator
(page=None, size=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the identity sequences.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_identity_sequence_generator
-
create_identity_sequence
(break_on_store_fail=None, certificate_authentication_profile=None, description=None, id_seq_item=None, name=None, parent=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates an identity sequence.
- Parameters
break_on_store_fail (boolean) – breakOnStoreFail, property of the request body.
certificate_authentication_profile (string) – certificateAuthenticationProfile, property of the request body.
description (string) – description, property of the request body.
id_seq_item (list) – idSeqItem, property of the request body (list of objects).
name (string) – name, property of the request body.
parent (string) – parent, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(break_on_store_fail=None, certificate_authentication_profile=None, description=None, id_seq_item=None, name=None, parent=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_identity_sequence
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the identity sequence.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
internal_user¶
-
class
InternalUser
[source]¶ Identity Services Engine InternalUser API (version: 3.1.0).
Wraps the Identity Services Engine InternalUser API and exposes the API as native Python methods that return native Python objects.
Internal User API allows the client to add, delete, update and search internal users.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
Revision Modification
Revision Modification
Attribute
Description
0
1.0
2.3
Initial Cisco ISE Version
1
1.1
2.6
Support new attribute Proxy Dead Timeout
proxyTimeout
Added int Attribute ‘proxyTimeout’
Resource Definition
Attribute
Type
Required
Description
Default Values
Example Values
name
String
Yes
Resource Name
name
id
String
No
Resource UUID, mandatory for update
b24b09e2-16f8-4e48-ace1-2c262a9449f1
description
String
No
description
changePassword
Boolean
Yes
true
email
String
No
enablePassword
String
No
EnablePassword field is added in ISE 2.0 to support T+
enablePassword
enabled
Boolean
Yes
Whether the user is enabled/disabled. To use it as filter, the values should be ‘Enabled’ or ‘Disabled’. The values are case sensitive. For example, ‘[ERSObjectURL]?filter=enabled.EQ.Enabled’
true
customAttributes
String
No
Key value map
{“key1” : “value1”}
firstName
String
No
firstName
identityGroups
String
No
CSV of identity group IDs
identityGroups
lastName
String
No
lastName
password
String
No
password
passwordIDStore
String
Yes
The id store where the internal user’s password is kept
Internal Users
expiryDateEnabled
Boolean
No
false
expiryDate
String
No
To store the internal user’s expiry date information. It’s format is = ‘YYYY-MM-DD’
2021-05-19
-
get_internal_user_by_name
(name, headers=None, **query_parameters)[source]¶ This API allows the client to get an internal user by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_name
(name, headers=None, **query_parameters)[source]¶ Alias for get_internal_user_by_name
-
update_internal_user_by_name
(name, change_password=None, custom_attributes=None, description=None, email=None, enable_password=None, enabled=None, expiry_date=None, expiry_date_enabled=None, first_name=None, id=None, identity_groups=None, last_name=None, password=None, password_idstore=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update an internal user by name.
- Parameters
change_password (boolean) – changePassword, property of the request body.
custom_attributes (object) – Key value map, property of the request body.
description (string) – description, property of the request body.
email (string) – email, property of the request body.
enable_password (string) – enablePassword, property of the request body.
enabled (boolean) – Whether the user is enabled/disabled. To use it as filter, the values should be ‘Enabled’ or ‘Disabled’. The values are case sensitive. For example, ‘[ERSOb jectURL]?filter=enabled.EQ.Enabled’, property of the request body.
expiry_date (string) – To store the internal user’s expiry date information. It’s format is = ‘YYYY-MM-DD’, property of the request body.
expiry_date_enabled (boolean) – expiryDateEnabled, property of the request body.
first_name (string) – firstName, property of the request body.
id (string) – id, property of the request body.
identity_groups (string) – CSV of identity group IDs, property of the request body.
last_name (string) – lastName, property of the request body.
name (basestring) – name, property of the request body.
password (string) – password, property of the request body.
password_idstore (string) – The id store where the internal user’s password is kept, property of the request body.
name – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_name
(name, change_password=None, custom_attributes=None, description=None, email=None, enable_password=None, enabled=None, expiry_date=None, expiry_date_enabled=None, first_name=None, id=None, identity_groups=None, last_name=None, password=None, password_idstore=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_internal_user_by_name
-
delete_internal_user_by_name
(name, headers=None, **query_parameters)[source]¶ This API deletes an internal user by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_name
(name, headers=None, **query_parameters)[source]¶ Alias for delete_internal_user_by_name
-
get_internal_user_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get an internal user by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_internal_user_by_id
-
update_internal_user_by_id
(id, change_password=None, custom_attributes=None, description=None, email=None, enable_password=None, enabled=None, expiry_date=None, expiry_date_enabled=None, first_name=None, identity_groups=None, last_name=None, name=None, password=None, password_idstore=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update an internal user by ID.
- Parameters
change_password (boolean) – changePassword, property of the request body.
custom_attributes (object) – Key value map, property of the request body.
description (string) – description, property of the request body.
email (string) – email, property of the request body.
enable_password (string) – enablePassword, property of the request body.
enabled (boolean) – Whether the user is enabled/disabled. To use it as filter, the values should be ‘Enabled’ or ‘Disabled’. The values are case sensitive. For example, ‘[ERSOb jectURL]?filter=enabled.EQ.Enabled’, property of the request body.
expiry_date (string) – To store the internal user’s expiry date information. It’s format is = ‘YYYY-MM-DD’, property of the request body.
expiry_date_enabled (boolean) – expiryDateEnabled, property of the request body.
first_name (string) – firstName, property of the request body.
id (basestring) – id, property of the request body.
identity_groups (string) – CSV of identity group IDs, property of the request body.
last_name (string) – lastName, property of the request body.
name (string) – name, property of the request body.
password (string) – password, property of the request body.
password_idstore (string) – The id store where the internal user’s password is kept, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, change_password=None, custom_attributes=None, description=None, email=None, enable_password=None, enabled=None, expiry_date=None, expiry_date_enabled=None, first_name=None, identity_groups=None, last_name=None, name=None, password=None, password_idstore=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_internal_user_by_id
-
delete_internal_user_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes an internal user by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_internal_user_by_id
-
get_internal_user
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the internal users. Filter: [firstName, lastName, identityGroup, name, description, email, enabled] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_internal_user
-
get_internal_user_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the internal users. Filter: [firstName, lastName, identityGroup, name, description, email, enabled] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_internal_user_generator
-
create_internal_user
(change_password=None, custom_attributes=None, description=None, email=None, enable_password=None, enabled=None, expiry_date=None, expiry_date_enabled=None, first_name=None, identity_groups=None, last_name=None, name=None, password=None, password_idstore=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates an internal user.
- Parameters
change_password (boolean) – changePassword, property of the request body.
custom_attributes (object) – Key value map, property of the request body.
description (string) – description, property of the request body.
email (string) – email, property of the request body.
enable_password (string) – enablePassword, property of the request body.
enabled (boolean) – Whether the user is enabled/disabled. To use it as filter, the values should be ‘Enabled’ or ‘Disabled’. The values are case sensitive. For example, ‘[ERSOb jectURL]?filter=enabled.EQ.Enabled’, property of the request body.
expiry_date (string) – To store the internal user’s expiry date information. It’s format is = ‘YYYY-MM-DD’, property of the request body.
expiry_date_enabled (boolean) – expiryDateEnabled, property of the request body.
first_name (string) – firstName, property of the request body.
identity_groups (string) – CSV of identity group IDs, property of the request body.
last_name (string) – lastName, property of the request body.
name (string) – name, property of the request body.
password (string) – password, property of the request body.
password_idstore (string) – The id store where the internal user’s password is kept, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(change_password=None, custom_attributes=None, description=None, email=None, enable_password=None, enabled=None, expiry_date=None, expiry_date_enabled=None, first_name=None, identity_groups=None, last_name=None, name=None, password=None, password_idstore=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_internal_user
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the internal user.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
mdm¶
-
class
Mdm
[source]¶ Identity Services Engine MDM API (version: 3.1.0).
Wraps the Identity Services Engine MDM API and exposes the API as native Python methods that return native Python objects.
# Cisco ISE 3.0 pxGrid REST APIs
## License [Cisco Sample Code License](https://developer.cisco.com/site/license/cisco-sample-code-license/)
## Status These are the status icons for the requests so far. - ⌗ : must create resources to test - 🚧 : incomplete | untested - 🛑 : unsupported | bug
## Environment Variables This collection uses environment variables in scripts in the Tests tab to store data (id, name, portalId, etc.) between requests. This allows you to GET or POST then immediately GET {id} on a resource. Using No Environment will cause this convenience functionality to fail so be sure to choose one.
## Collection Variables This collection includes some default variables that you will want to update or override with environment variables for your ISE deployment. Specifically, you will want to set: - ise_pxg: the ISE PAN node name or IP address. Default: ise.securitydemo.net - rest_username: the username for ERS API access. Must be a member of SuperAdmin, ERSAdmin or ERSOperator groups. Default: admin which is the ISE SuperAdmin - rest_password: Default: C1sco12345
-
get_endpoints
(headers=None, **query_parameters)[source]¶ 🚧 getEndpoints.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(headers=None, **query_parameters)[source]¶ Alias for get_endpoints
-
get_endpoint_by_mac_address
(headers=None, **query_parameters)[source]¶ 🚧 getEndpointByMacAddress.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_endpoints_by_type
(headers=None, **query_parameters)[source]¶ 🚧 getEndpointsByType.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_endpoints_by_os_type
(headers=None, **query_parameters)[source]¶ 🚧 getEndpointsByOsType.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
misc¶
-
class
Misc
[source]¶ Identity Services Engine Misc API (version: 3.1.0).
Wraps the Identity Services Engine Misc API and exposes the API as native Python methods that return native Python objects.
# Cisco ISE 3.0 MNT REST APIs
## License [Cisco Sample Code License](https://developer.cisco.com/site/license/cisco-sample-code-license/)
## Status These are the status icons for the requests so far. - ⌗ : must create resources to test - 🚧 : incomplete | untested - 🛑 : unsupported | bug
## Environment Variables This collection uses environment variables in scripts in the Tests tab to store data (id, name, portalId, etc.) between requests. This allows you to GET or POST then immediately GET {id} on a resource. Using No Environment will cause this convenience functionality to fail so be sure to choose one.
## Collection Variables This collection includes some default variables that you will want to update or override with environment variables for your ISE deployment. Specfically, you will want to set: - ise_mnt: the ISE PAN node name or IP address. Default: ise.securitydemo.net - rest_username: the username for ERS API access. Must be a member of SuperAdmin, ERSAdmin or ERSOperator groups. Default: admin which is the ISE SuperAdmin - rest_password: Default: C1sco12345
-
get_active_count
(headers=None, **query_parameters)[source]¶ ActiveCount.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_active_list
(headers=None, **query_parameters)[source]¶ ActiveList.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_session_auth_list
(headers=None, **query_parameters)[source]¶ Session/AuthList.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_posture_count
(headers=None, **query_parameters)[source]¶ PostureCount.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_profiler_count
(headers=None, **query_parameters)[source]¶ ProfilerCount.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_sessions_by_mac
(mac, headers=None, **query_parameters)[source]¶ Sessions by MAC.
- Parameters
mac (basestring) – mac path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_sessions_by_username
(username, headers=None, **query_parameters)[source]¶ Sessions by Username.
- Parameters
username (basestring) – username path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_sessions_by_nas_ip
(nas_ipv4, headers=None, **query_parameters)[source]¶ Sessions by NAS IP.
- Parameters
nas_ipv4 (basestring) – nas_ipv4 path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_sessions_by_endpoint_ip
(endpoint_ipv4, headers=None, **query_parameters)[source]¶ Sessions by Endpoint IP.
- Parameters
endpoint_ipv4 (basestring) – endpoint_ipv4 path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_sessions_by_session_id
(session_id, headers=None, **query_parameters)[source]¶ Sessions by SessionID.
- Parameters
session_id (basestring) – session_id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_all_sessions
(headers=None, **query_parameters)[source]¶ Delete All Sessions.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_mnt_version
(headers=None, **query_parameters)[source]¶ MNT Version.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_failure_reasons
(headers=None, **query_parameters)[source]¶ FailureReasons.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_authentication_status_by_mac
(mac, rec_ord_s, sec_ond_s, headers=None, **query_parameters)[source]¶ AuthenticationStatus by MAC.
- Parameters
mac (basestring) – MAC path parameter.
sec_ond_s (basestring) – SECONDS path parameter.
rec_ord_s (basestring) – RECORDS path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
session_reauthentication_by_mac
(end_poi_ntm_ac, psn_nam_e, rea_uth_typ_e, headers=None, **query_parameters)[source]¶ Session Reauthentication by MAC.
- Parameters
psn_nam_e (basestring) – PSN_NAME path parameter.
end_poi_ntm_ac (basestring) – ENDPOINT_MAC path parameter.
rea_uth_typ_e (basestring) – REAUTH_TYPE path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
session_disconnect
(dis_con_nec_tty_pe, end_poi_nti_p, mac, nas_ipv4, psn_nam_e, headers=None, **query_parameters)[source]¶ Session Disconnect.
- Parameters
end_poi_nti_p (basestring) – ENDPOINT_IP path parameter.
psn_nam_e (basestring) – PSN_NAME path parameter.
mac (basestring) – MAC path parameter.
dis_con_nec_tty_pe (basestring) – DISCONNECT_TYPE path parameter.
nas_ipv4 (basestring) – NAS_IPV4 path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_account_status_by_mac
(duration, mac, headers=None, **query_parameters)[source]¶ AccountStatus by MAC.
- Parameters
mac (basestring) – mac path parameter.
duration (basestring) – duration path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
my_device_portal¶
-
class
MyDevicePortal
[source]¶ Identity Services Engine MyDevicePortal API (version: 3.1.0).
Wraps the Identity Services Engine MyDevicePortal API and exposes the API as native Python methods that return native Python objects.
My Device Portal API provides the ability to create, read, update, delete and search my device portals.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.2
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Default Values
Example Values
name
String
Yes
Resource Name
My Devices Portal (default)
id
String
No
Resource UUID, mandatory for update
901f1b37-4a2f-46d9-8653-d925d2dde3aa
description
String
No
Default portal used by employees to register and manage their personal devices
portalTestUrl
String
No
URL to bring up a test page for this portal
https://{ise-ip}:8443/mydevicesportal/PortalSetup.action?portal=901f1b37-4a2f-46d9-8653-d925d2dde3aa
portalType
Enum
Yes
Allowed values: BYOD, HOTSPOTGUEST, MYDEVICE, SELFREGGUEST, SPONSOR, SPONSOREDGUEST
MYDEVICE
settings
List
No
Defines all of the settings groups available for a Mydevice portal
portalSettings
List
No
The port, interface, certificate, and other basic settings of a portal
httpsPort
Integer
Yes
The port number that the allowed interfaces will listen on. Range from 8000 to 8999
8443
allowedInterfaces
Enum
Yes
Interfaces that the portal will be reachable on. Allowed values: eth0, eth1, eth2, eth3, eth4, eth5, bond0, bond1, bond2
[ “eth0”, “bond0” ]
certificateGroupTag
String
Yes
Logical name of the x.509 server certificate that will be used for the portal
Default Portal Certificate Group
endpointIdentityGroup
String
Yes
Unique Id of the endpoint identity group where user’s devices will be added. Used only in Hotspot Portal
aa178bd0-8bff-11e6-996c-525400b48521
displayLang
Enum
No
Allowed values: USEBROWSERLOCALE, ALWAYSUSE
USEBROWSERLOCALE
fallbackLanguage
String
No
Used when displayLang = USEBROWSERLOCALE
English
alwaysUsedLanguage
String
No
Used when displayLang = ALWAYSUSE
English
loginPageSettings
List
No
Portal Login Page settings groups follow
maxFailedAttemptsBeforeRateLimit
Integer
No
Maximum failed login attempts before rate limiting
5
timeBetweenLoginsDuringRateLimit
Integer
No
2
includeAup
Boolean
No
Include an Acceptable Use Policy (AUP) that should be displayed during login
false
aupDisplay
Enum
No
How the AUP should be displayed, either on page or as a link. Only valid if includeAup = true. Allowed values: ONPAGE, ASLINK - ONPAGE, - ASLINK
ASLINK
requireAupAcceptance
Boolean
No
Require the portal user to accept the AUP. Only valid if includeAup = true
false
requireScrolling
Boolean
No
Require the portal user to scroll to the end of the AUP. Only valid if requireAupAcceptance = true
false
aupSettings
List
No
Configuration of the Acceptable Use Policy (AUP) for a portal
displayFrequency
Enum
No
How the AUP should be displayed, either on page or as a link. Only valid if includeAup = true.
FIRSTLOGIN
includeAup
Boolean
No
Require the portal user to read and accept an AUP
true
requireScrolling
Boolean
No
Require the portal user to scroll to the end of the AUP. Only valid if requireAupAcceptance = true
false
displayFrequencyIntervalDays
Integer
No
Number of days between AUP confirmations (when displayFrequency = recurring)
7
employeeChangePasswordSettings
List
No
allowEmployeeToChangePwd
Boolean
No
Allow employees to change their own passwords
false
postLoginBannerSettings
List
No
includePostAccessBanner
Boolean
No
Include a Post-Login Banner page
false
supportInfoSettings
List
No
Portal Support Information Settings
includeSupportInfoPage
Boolean
No
false
includeMacAddr
Boolean
No
false
includeIpAddress
Boolean
No
false
includeBrowserUserAgent
Boolean
No
false
includePolicyServer
Boolean
No
false
includeFailureCode
Boolean
No
false
emptyFieldDisplay
Enum
No
Specifies how empty fields are handled on the Support Information Page.
HIDE
defaultEmptyFieldValue
String
No
The default value displayed for an empty field Only valid when emptyFieldDisplay = DISPLAYWITHDEFAULTVALUE
customizations
List
No
Defines all of the Portal Customizations available
portalTheme
List
No
Defines the configuration for portal theme
id
String
No
The unique internal identifier of the portal theme
9eb421c0-8c01-11e6-996c-525400b48521
name
String
Yes
The system- or user-assigned name of the portal theme
Default Blue theme
themeData
String
No
A CSS file, represented as a Base64-encoded byte array
Base 64 encoded string of Theme CSS file
portalTweakSettings
List
No
The Tweak Settings are a customization of the Portal Theme that has been selected for the portal. When the Portal Theme selection is changed, the Tweak Settings are overwritten to match the values in the theme. The Tweak Settings can subsequently be changed by the user
bannerColor
String
No
Hex value of color
#0000FF
bannerTextColor
String
No
Banner Text color code from GUI
pageBackgroundColor
String
No
Color code from GUI
pageLabelAndTextColor
String
No
Label and Text color from GUI
language
List
No
This property is supported only for Read operation and it allows to show the customizations in English. Other languages are not supported
viewLanguage
String
No
English
globalCustomizations
List
No
Represent the portal Global customizations
bannerTitle
String
No
My Devices Portal
contactText
String
No
Contact Support
footerElement
String
No
Footer Element
mobileLogoImage
Image
No
data
String
No
Represented as base 64 encoded string of the image byte array
base 64 encoded value of image
desktopLogoImage
Image
No
data
String
No
Represented as base 64 encoded string of the image byte array
base 64 encoded value of image
bannerImage
Image
No
data
String
No
Represented as base 64 encoded string of the image byte array
base 64 encoded value of image
backgroundImage
Image
No
data
String
No
Represented as base 64 encoded string of the image byte array
base 64 encoded value of image
pageCustomizations
List
No
Represent the entire page customization as a giant dictionary
data
List
No
The Dictionary will be exposed here as key value pair
key
String
Yes
ui_contact_ip_address_label
value
String
Yes
SVAgYWRkcmVzczo=
-
get_my_device_portal_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get a my device portal by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_my_device_portal_by_id
-
update_my_device_portal_by_id
(id, customizations=None, description=None, name=None, portal_test_url=None, portal_type=None, settings=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update a my device portal by ID.
- Parameters
customizations (object) – Defines all of the Portal Customizations available, property of the request body.
description (string) – description, property of the request body.
id (basestring) – id, property of the request body.
name (string) – name, property of the request body.
portal_test_url (string) – URL to bring up a test page for this portal, property of the request body.
portal_type (string) – Allowed values: BYOD, HOTSPOTGUEST, MYDEVICE, SELFREGGUEST, SPONSOR, SPONSOREDGUEST, property of the request body.
settings (object) – Defines all of the settings groups available for a Mydevice portal, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, customizations=None, description=None, name=None, portal_test_url=None, portal_type=None, settings=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_my_device_portal_by_id
-
delete_my_device_portal_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes a my device portal by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_my_device_portal_by_id
-
get_my_device_portal
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the my device portals. Filter: [name, description] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_my_device_portal
-
get_my_device_portal_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the my device portals. Filter: [name, description] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_my_device_portal_generator
-
create_my_device_portal
(customizations=None, description=None, name=None, portal_test_url=None, portal_type=None, settings=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates a my device portal.
- Parameters
customizations (object) – Defines all of the Portal Customizations available, property of the request body.
description (string) – description, property of the request body.
name (string) – name, property of the request body.
portal_test_url (string) – URL to bring up a test page for this portal, property of the request body.
portal_type (string) – Allowed values: BYOD, HOTSPOTGUEST, MYDEVICE, SELFREGGUEST, SPONSOR, SPONSOREDGUEST, property of the request body.
settings (object) – Defines all of the settings groups available for a Mydevice portal, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(customizations=None, description=None, name=None, portal_test_url=None, portal_type=None, settings=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_my_device_portal
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the my device portal.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
native_supplicant_profile¶
-
class
NativeSupplicantProfile
[source]¶ Identity Services Engine NativeSupplicantProfile API (version: 3.1.0).
Wraps the Identity Services Engine NativeSupplicantProfile API and exposes the API as native Python methods that return native Python objects.
Native supplicant profile API provides the ability to update, delete and search native supplicant profiles.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.2
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Example Values
name
String
Yes
Resource Name
Cisco-ISE-NSP
id
String
No
Resource UUID, mandatory for update
b8ce01e6-b150-4d4e-9698-40e48d5e0197
description
String
No
Pre-configured Native Supplicant Profile. The SSID Will Need To Be Customized For Your Environment
wirelessProfiles
List
Yes
List of Wireless profiles
ssid
String
Yes
SSID for the wireless profile
ISE
allowedProtocol
Enum
Yes
Allowed protocol for the wireless profile.
TLS
certificateTemplateId
String
No
Certificate template ID
0ca8f1b6-500d-560b-e053-75189a0ab0d1
actionType
Enum
Yes
Action type for WifiProfile.
UPDATE
previousSsid
String
Yes
Previous ssid for WifiProfile (required for updating existing WirelessProfile)
ssid1
-
get_native_supplicant_profile_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get a native supplicant profile by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_native_supplicant_profile_by_id
-
update_native_supplicant_profile_by_id
(id, description=None, name=None, wireless_profiles=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update a native supplicant profile.
- Parameters
description (string) – description, property of the request body.
id (basestring) – id, property of the request body.
name (string) – name, property of the request body.
wireless_profiles (list) – wirelessProfiles, property of the request body (list of objects).
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, description=None, name=None, wireless_profiles=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_native_supplicant_profile_by_id
-
delete_native_supplicant_profile_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes a native supplicant profile.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_native_supplicant_profile_by_id
-
get_native_supplicant_profile
(page=None, size=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the native supplicant profiles.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_native_supplicant_profile
-
get_native_supplicant_profile_generator
(page=None, size=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the native supplicant profiles.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_native_supplicant_profile_generator
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the native supplicant profile.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
network_access_authentication_rules¶
-
class
NetworkAccessAuthenticationRules
[source]¶ Identity Services Engine Network Access - Authentication Rules API (version: 3.1.0).
Wraps the Identity Services Engine Network Access - Authentication Rules API and exposes the API as native Python methods that return native Python objects.
-
get_network_access_authentication_rules
(policy_id, headers=None, **query_parameters)[source]¶ Network Access Get authentication rules.
- Parameters
policy_id (basestring) – policyId path parameter. Policy id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(policy_id, headers=None, **query_parameters)[source]¶ Alias for get_network_access_authentication_rules
-
create_network_access_authentication_rule
(policy_id, identity_source_name=None, if_auth_fail=None, if_process_fail=None, if_user_not_found=None, link=None, rule=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Network Access Create authentication rule: Rule must include name and condition. Condition has hierarchical structure which define a set of conditions for which authentication policy rule could be match. Condition can be either reference to a stored Library condition, using model ConditionReference or dynamically built conditions which are not stored in the conditions Library, using models ConditionAttributes, ConditionAndBlock, ConditionOrBlock . .
- Parameters
identity_source_name (string) – Identity source name from the identity stores, property of the request body.
if_auth_fail (string) – Action to perform when authentication fails such as Bad credentials, disabled user and so on, property of the request body.
if_process_fail (string) – Action to perform when ISE is uanble to access the identity database, property of the request body.
if_user_not_found (string) – Action to perform when user is not found in any of identity stores, property of the request body.
link (object) – link, property of the request body.
rule (object) – Common attributes in rule authentication/authorization, property of the request body.
policy_id (basestring) – policyId path parameter. Policy id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(policy_id, identity_source_name=None, if_auth_fail=None, if_process_fail=None, if_user_not_found=None, link=None, rule=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
-
reset_hit_counts_network_access_authentication_rules
(policy_id, headers=None, **query_parameters)[source]¶ Network Access Reset HitCount for Authentication Rules.
- Parameters
policy_id (basestring) – policyId path parameter. Policy id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
reset_hit_counts_by_id
(policy_id, headers=None, **query_parameters)[source]¶ Alias for reset_hit_counts_network_access_authentication_rules
-
get_network_access_authentication_rule_by_id
(id, policy_id, headers=None, **query_parameters)[source]¶ Network Access Get rule attributes.
- Parameters
policy_id (basestring) – policyId path parameter. Policy id.
id (basestring) – id path parameter. Rule id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_network_access_authentication_rule_by_id
(id, policy_id, identity_source_name=None, if_auth_fail=None, if_process_fail=None, if_user_not_found=None, link=None, rule=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Network Access Update rule.
- Parameters
identity_source_name (string) – Identity source name from the identity stores, property of the request body.
if_auth_fail (string) – Action to perform when authentication fails such as Bad credentials, disabled user and so on, property of the request body.
if_process_fail (string) – Action to perform when ISE is uanble to access the identity database, property of the request body.
if_user_not_found (string) – Action to perform when user is not found in any of identity stores, property of the request body.
link (object) – link, property of the request body.
rule (object) – Common attributes in rule authentication/authorization, property of the request body.
policy_id (basestring) – policyId path parameter. Policy id.
id (basestring) – id path parameter. Rule id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, policy_id, identity_source_name=None, if_auth_fail=None, if_process_fail=None, if_user_not_found=None, link=None, rule=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
-
delete_network_access_authentication_rule_by_id
(id, policy_id, headers=None, **query_parameters)[source]¶ Network Access Delete rule.
- Parameters
policy_id (basestring) – policyId path parameter. Policy id.
id (basestring) – id path parameter. Rule id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
network_access_conditions¶
-
class
NetworkAccessConditions
[source]¶ Identity Services Engine Network Access - Conditions API (version: 3.1.0).
Wraps the Identity Services Engine Network Access - Conditions API and exposes the API as native Python methods that return native Python objects.
-
get_network_access_conditions
(headers=None, **query_parameters)[source]¶ Network Access Returns all library conditions.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(headers=None, **query_parameters)[source]¶ Alias for get_network_access_conditions
-
create_network_access_condition
(attribute_name=None, attribute_value=None, children=None, condition_type=None, dates_range=None, dates_range_exception=None, description=None, dictionary_name=None, dictionary_value=None, hours_range=None, hours_range_exception=None, id=None, is_negate=None, link=None, name=None, operator=None, week_days=None, week_days_exception=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Network Access Creates a library condition: Library Condition has hierarchical structure which define a set of condition for which authentication and authorization policy rules could be match. Condition can be compose from single dictionary attribute name and value using model LibraryConditionAttributes , or from combination of dictionary attributes with logical operation of AND/OR between them, using models: LibraryConditionAndBlock or LibraryConditionOrBlock . When using AND/OR blocks, the condition will include inner layers inside these blocks, these layers are built using the inner condition models: ConditionAttributes , ConditionAndBlock , ConditionOrBlock , that represent dynamically built Conditions which are not stored in the conditions Library, or using ConditionReference , which includes an ID to existing stored condition in the library. The LibraryCondition models can only be used in the outer-most layer (root of the condition) and must always include the condition name. When using one of the 3 inner condition models ( ConditionAttributes, ConditionAndBlock, ConditionOrBlock ), condition name cannot be included in the request, since these will not be stored in the conditions library, and used only as inner members of the root condition. When using ConditionReference model in inner layers, the condition name is not required. ConditionReference objects can also include a reference ID to a condition of type TimeAndDate . .
- Parameters
attribute_name (string) – Dictionary attribute name, property of the request body.
attribute_value (string) – Attribute value for condition Value type is specified in dictionary object if multiple values allowed is specified in dictionary object, property of the request body.
children (list) – In case type is andBlock or orBlock addtional conditions will be aggregated under this logical (OR/AND) condition, property of the request body (list of objects).
condition_type (string) – Inidicates whether the record is the condition itself(data) or a logical(or,and) aggregation Data type enum(reference,single) indicates than “conditonId” OR “ConditionAttrs” fields should contain condition data but not both Logical aggreation(and,or) enum indicates that additional conditions are present under the children field, property of the request body. Available values are ‘ConditionAndBlock’, ‘ConditionAttributes’, ‘ConditionOrBlock’, ‘ConditionReference’, ‘LibraryConditionAndBlock’, ‘LibraryConditionAttributes’, ‘LibraryConditionOrBlock’ and ‘TimeAndDateCondition’.
dates_range (object) – Defines for which date/s TimeAndDate condition will be matched Options are Date range, for specific date, the same date should be used for start/end date Default no specific dates In order to reset the dates to have no specific dates Date format yyyy- mm-dd (MM = month, dd = day, yyyy = year), property of the request body.
dates_range_exception (object) – Defines for which date/s TimeAndDate condition will be matched Options are Date range, for specific date, the same date should be used for start/end date Default no specific dates In order to reset the dates to have no specific dates Date format yyyy- mm-dd (MM = month, dd = day, yyyy = year), property of the request body.
description (string) – Condition description, property of the request body.
dictionary_name (string) – Dictionary name, property of the request body.
dictionary_value (string) – Dictionary value, property of the request body.
hours_range (object) – Defines for which hours a TimeAndDate condition will be matched Time format hh:mm ( h = hour , mm = minutes ) Default All Day , property of the request body.
hours_range_exception (object) – Defines for which hours a TimeAndDate condition will be matched Time format hh:mm ( h = hour , mm = minutes ) Default All Day , property of the request body.
id (string) – id, property of the request body.
is_negate (boolean) – Indicates whereas this condition is in negate mode, property of the request body.
link (object) – link, property of the request body.
name (string) – Condition name, property of the request body.
operator (string) – Equality operator, property of the request body. Available values are ‘contains’, ‘endsWith’, ‘equals’, ‘greaterOrEquals’, ‘greaterThan’, ‘in’, ‘ipEquals’, ‘ipGreaterThan’, ‘ipLessThan’, ‘ipNotEquals’, ‘lessOrEquals’, ‘lessThan’, ‘matches’, ‘notContains’, ‘notEndsWith’, ‘notEquals’, ‘notIn’, ‘notStartsWith’ and ‘startsWith’.
week_days (list) – Defines for which days this condition will be matched Days format Arrays of WeekDay enums Default List of All week days, property of the request body (list of strings. Available values are ‘Friday’, ‘Monday’, ‘Saturday’, ‘Sunday’, ‘Thursday’, ‘Tuesday’ and ‘Wednesday’).
week_days_exception (list) – Defines for which days this condition will NOT be matched Days format Arrays of WeekDay enums Default Not enabled, property of the request body (list of strings. Available values are ‘Friday’, ‘Monday’, ‘Saturday’, ‘Sunday’, ‘Thursday’, ‘Tuesday’ and ‘Wednesday’).
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(attribute_name=None, attribute_value=None, children=None, condition_type=None, dates_range=None, dates_range_exception=None, description=None, dictionary_name=None, dictionary_value=None, hours_range=None, hours_range_exception=None, id=None, is_negate=None, link=None, name=None, operator=None, week_days=None, week_days_exception=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_network_access_condition
-
get_network_access_conditions_for_authentication_rules
(headers=None, **query_parameters)[source]¶ Network Access Returns list of library conditions for Authentication rules scope.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
Network Access Returns list of library conditions for Authorization rules scope.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_network_access_condition_by_name
(name, headers=None, **query_parameters)[source]¶ Network Access Returns a library condition.
- Parameters
name (basestring) – name path parameter. Condition name.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_name
(name, headers=None, **query_parameters)[source]¶ Alias for get_network_access_condition_by_name
-
update_network_access_condition_by_name
(name, attribute_name=None, attribute_value=None, children=None, condition_type=None, dates_range=None, dates_range_exception=None, description=None, dictionary_name=None, dictionary_value=None, hours_range=None, hours_range_exception=None, id=None, is_negate=None, link=None, operator=None, week_days=None, week_days_exception=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Network Access Update library condition using condition name.
- Parameters
attribute_name (string) – Dictionary attribute name, property of the request body.
attribute_value (string) – Attribute value for condition Value type is specified in dictionary object if multiple values allowed is specified in dictionary object, property of the request body.
children (list) – In case type is andBlock or orBlock addtional conditions will be aggregated under this logical (OR/AND) condition, property of the request body (list of objects).
condition_type (string) – Inidicates whether the record is the condition itself(data) or a logical(or,and) aggregation Data type enum(reference,single) indicates than “conditonId” OR “ConditionAttrs” fields should contain condition data but not both Logical aggreation(and,or) enum indicates that additional conditions are present under the children field, property of the request body. Available values are ‘ConditionAndBlock’, ‘ConditionAttributes’, ‘ConditionOrBlock’, ‘ConditionReference’, ‘LibraryConditionAndBlock’, ‘LibraryConditionAttributes’, ‘LibraryConditionOrBlock’ and ‘TimeAndDateCondition’.
dates_range (object) – Defines for which date/s TimeAndDate condition will be matched Options are Date range, for specific date, the same date should be used for start/end date Default no specific dates In order to reset the dates to have no specific dates Date format yyyy- mm-dd (MM = month, dd = day, yyyy = year), property of the request body.
dates_range_exception (object) – Defines for which date/s TimeAndDate condition will be matched Options are Date range, for specific date, the same date should be used for start/end date Default no specific dates In order to reset the dates to have no specific dates Date format yyyy- mm-dd (MM = month, dd = day, yyyy = year), property of the request body.
description (string) – Condition description, property of the request body.
dictionary_name (string) – Dictionary name, property of the request body.
dictionary_value (string) – Dictionary value, property of the request body.
hours_range (object) – Defines for which hours a TimeAndDate condition will be matched Time format hh:mm ( h = hour , mm = minutes ) Default All Day , property of the request body.
hours_range_exception (object) – Defines for which hours a TimeAndDate condition will be matched Time format hh:mm ( h = hour , mm = minutes ) Default All Day , property of the request body.
id (string) – id, property of the request body.
is_negate (boolean) – Indicates whereas this condition is in negate mode, property of the request body.
link (object) – link, property of the request body.
name (basestring) – Condition name, property of the request body.
operator (string) – Equality operator, property of the request body. Available values are ‘contains’, ‘endsWith’, ‘equals’, ‘greaterOrEquals’, ‘greaterThan’, ‘in’, ‘ipEquals’, ‘ipGreaterThan’, ‘ipLessThan’, ‘ipNotEquals’, ‘lessOrEquals’, ‘lessThan’, ‘matches’, ‘notContains’, ‘notEndsWith’, ‘notEquals’, ‘notIn’, ‘notStartsWith’ and ‘startsWith’.
week_days (list) – Defines for which days this condition will be matched Days format Arrays of WeekDay enums Default List of All week days, property of the request body (list of strings. Available values are ‘Friday’, ‘Monday’, ‘Saturday’, ‘Sunday’, ‘Thursday’, ‘Tuesday’ and ‘Wednesday’).
week_days_exception (list) – Defines for which days this condition will NOT be matched Days format Arrays of WeekDay enums Default Not enabled, property of the request body (list of strings. Available values are ‘Friday’, ‘Monday’, ‘Saturday’, ‘Sunday’, ‘Thursday’, ‘Tuesday’ and ‘Wednesday’).
name – name path parameter. Condition name.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_name
(name, attribute_name=None, attribute_value=None, children=None, condition_type=None, dates_range=None, dates_range_exception=None, description=None, dictionary_name=None, dictionary_value=None, hours_range=None, hours_range_exception=None, id=None, is_negate=None, link=None, operator=None, week_days=None, week_days_exception=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_network_access_condition_by_name
-
delete_network_access_condition_by_name
(name, headers=None, **query_parameters)[source]¶ Network Access Delete a library condition using condition Name.
- Parameters
name (basestring) – name path parameter. Condition name.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_name
(name, headers=None, **query_parameters)[source]¶ Alias for delete_network_access_condition_by_name
-
get_network_access_conditions_for_policy_sets
(headers=None, **query_parameters)[source]¶ Network Access Returns list of library conditions for PolicySet scope.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_network_access_condition_by_id
(id, headers=None, **query_parameters)[source]¶ Network Access Returns a library condition.
- Parameters
id (basestring) – id path parameter. Condition id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_network_access_condition_by_id
-
update_network_access_condition_by_id
(id, attribute_name=None, attribute_value=None, children=None, condition_type=None, dates_range=None, dates_range_exception=None, description=None, dictionary_name=None, dictionary_value=None, hours_range=None, hours_range_exception=None, is_negate=None, link=None, name=None, operator=None, week_days=None, week_days_exception=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Network Access Update library condition.
- Parameters
attribute_name (string) – Dictionary attribute name, property of the request body.
attribute_value (string) – Attribute value for condition Value type is specified in dictionary object if multiple values allowed is specified in dictionary object, property of the request body.
children (list) – In case type is andBlock or orBlock addtional conditions will be aggregated under this logical (OR/AND) condition, property of the request body (list of objects).
condition_type (string) – Inidicates whether the record is the condition itself(data) or a logical(or,and) aggregation Data type enum(reference,single) indicates than “conditonId” OR “ConditionAttrs” fields should contain condition data but not both Logical aggreation(and,or) enum indicates that additional conditions are present under the children field, property of the request body. Available values are ‘ConditionAndBlock’, ‘ConditionAttributes’, ‘ConditionOrBlock’, ‘ConditionReference’, ‘LibraryConditionAndBlock’, ‘LibraryConditionAttributes’, ‘LibraryConditionOrBlock’ and ‘TimeAndDateCondition’.
dates_range (object) – Defines for which date/s TimeAndDate condition will be matched Options are Date range, for specific date, the same date should be used for start/end date Default no specific dates In order to reset the dates to have no specific dates Date format yyyy- mm-dd (MM = month, dd = day, yyyy = year), property of the request body.
dates_range_exception (object) – Defines for which date/s TimeAndDate condition will be matched Options are Date range, for specific date, the same date should be used for start/end date Default no specific dates In order to reset the dates to have no specific dates Date format yyyy- mm-dd (MM = month, dd = day, yyyy = year), property of the request body.
description (string) – Condition description, property of the request body.
dictionary_name (string) – Dictionary name, property of the request body.
dictionary_value (string) – Dictionary value, property of the request body.
hours_range (object) – Defines for which hours a TimeAndDate condition will be matched Time format hh:mm ( h = hour , mm = minutes ) Default All Day , property of the request body.
hours_range_exception (object) – Defines for which hours a TimeAndDate condition will be matched Time format hh:mm ( h = hour , mm = minutes ) Default All Day , property of the request body.
id (basestring) – id, property of the request body.
is_negate (boolean) – Indicates whereas this condition is in negate mode, property of the request body.
link (object) – link, property of the request body.
name (string) – Condition name, property of the request body.
operator (string) – Equality operator, property of the request body. Available values are ‘contains’, ‘endsWith’, ‘equals’, ‘greaterOrEquals’, ‘greaterThan’, ‘in’, ‘ipEquals’, ‘ipGreaterThan’, ‘ipLessThan’, ‘ipNotEquals’, ‘lessOrEquals’, ‘lessThan’, ‘matches’, ‘notContains’, ‘notEndsWith’, ‘notEquals’, ‘notIn’, ‘notStartsWith’ and ‘startsWith’.
week_days (list) – Defines for which days this condition will be matched Days format Arrays of WeekDay enums Default List of All week days, property of the request body (list of strings. Available values are ‘Friday’, ‘Monday’, ‘Saturday’, ‘Sunday’, ‘Thursday’, ‘Tuesday’ and ‘Wednesday’).
week_days_exception (list) – Defines for which days this condition will NOT be matched Days format Arrays of WeekDay enums Default Not enabled, property of the request body (list of strings. Available values are ‘Friday’, ‘Monday’, ‘Saturday’, ‘Sunday’, ‘Thursday’, ‘Tuesday’ and ‘Wednesday’).
id – id path parameter. Condition id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, attribute_name=None, attribute_value=None, children=None, condition_type=None, dates_range=None, dates_range_exception=None, description=None, dictionary_name=None, dictionary_value=None, hours_range=None, hours_range_exception=None, is_negate=None, link=None, name=None, operator=None, week_days=None, week_days_exception=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_network_access_condition_by_id
-
delete_network_access_condition_by_id
(id, headers=None, **query_parameters)[source]¶ Network Access Delete a library condition.
- Parameters
id (basestring) – id path parameter. Condition id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_network_access_condition_by_id
-
network_access_dictionary¶
-
class
NetworkAccessDictionary
[source]¶ Identity Services Engine Network Access - Dictionary API (version: 3.1.0).
Wraps the Identity Services Engine Network Access - Dictionary API and exposes the API as native Python methods that return native Python objects.
-
get_network_access_dictionaries
(headers=None, **query_parameters)[source]¶ Get all Dictionaries.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(headers=None, **query_parameters)[source]¶ Alias for get_network_access_dictionaries
-
create_network_access_dictionaries
(description=None, dictionary_attr_type=None, id=None, link=None, name=None, version=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Network Access Create a new Dictionary.
- Parameters
description (string) – The description of the Dictionary, property of the request body.
dictionary_attr_type (string) – The dictionary attribute type, property of the request body. Available values are ‘ENTITY_ATTR’, ‘MSG_ATTR’ and ‘PIP_ATTR’.
id (string) – Identifier for the dictionary, property of the request body.
link (object) – link, property of the request body.
name (string) – The dictionary name, property of the request body.
version (string) – The dictionary version, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(description=None, dictionary_attr_type=None, id=None, link=None, name=None, version=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_network_access_dictionaries
-
get_network_access_dictionary_by_name
(name, headers=None, **query_parameters)[source]¶ GET a dictionary by name.
- Parameters
name (basestring) – name path parameter. the dictionary name.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_name
(name, headers=None, **query_parameters)[source]¶ Alias for get_network_access_dictionary_by_name
-
update_network_access_dictionary_by_name
(name, description=None, dictionary_attr_type=None, id=None, link=None, version=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Network Access Update a Dictionary.
- Parameters
description (string) – The description of the Dictionary, property of the request body.
dictionary_attr_type (string) – The dictionary attribute type, property of the request body. Available values are ‘ENTITY_ATTR’, ‘MSG_ATTR’ and ‘PIP_ATTR’.
id (string) – Identifier for the dictionary, property of the request body.
link (object) – link, property of the request body.
name (basestring) – The dictionary name, property of the request body.
version (string) – The dictionary version, property of the request body.
name – name path parameter. the dictionary name.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_name
(name, description=None, dictionary_attr_type=None, id=None, link=None, version=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_network_access_dictionary_by_name
-
delete_network_access_dictionary_by_name
(name, headers=None, **query_parameters)[source]¶ Network Access Delete a Dictionary.
- Parameters
name (basestring) – name path parameter. the dictionary name.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_name
(name, headers=None, **query_parameters)[source]¶ Alias for delete_network_access_dictionary_by_name
-
network_access_dictionary_attribute¶
-
class
NetworkAccessDictionaryAttribute
[source]¶ Identity Services Engine Network Access - Dictionary Attribute API (version: 3.1.0).
Wraps the Identity Services Engine Network Access - Dictionary Attribute API and exposes the API as native Python methods that return native Python objects.
-
get_network_access_dictionary_attributes_by_dictionary_name
(dictionary_name, headers=None, **query_parameters)[source]¶ Returns a list of Dictionary Attributes for an existing Dictionary.
- Parameters
dictionary_name (basestring) – dictionaryName path parameter. the name of the dictionary the dictionary attribute belongs to.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(dictionary_name, headers=None, **query_parameters)[source]¶ Alias for get_network_access_dictionary_attributes_by_dictionary_name
-
create_network_access_dictionary_attribute
(dictionary_name, allowed_values=None, data_type=None, description=None, direction_type=None, id=None, internal_name=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Create a new Dictionary Attribute for an existing Dictionary.
- Parameters
allowed_values (list) – all of the allowed values for the dictionary attribute, property of the request body (list of objects).
data_type (string) – the data type for the dictionary attribute, property of the request body. Available values are ‘BOOLEAN’, ‘DATE’, ‘FLOAT’, ‘INT’, ‘IP’, ‘IPV4’, ‘IPV6’, ‘IPV6INTERFACE’, ‘IPV6PREFIX’, ‘LONG’, ‘OCTET_STRING’, ‘STRING’, ‘UINT64’ and ‘UNIT32’.
description (string) – The description of the Dictionary attribute, property of the request body.
dictionary_name (basestring) – the name of the dictionary which the dictionary attribute belongs to, property of the request body.
direction_type (string) – the direction for the useage of the dictionary attribute, property of the request body. Available values are ‘BOTH’, ‘IN’, ‘NONE’ and ‘OUT’.
id (string) – Identifier for the dictionary attribute, property of the request body.
internal_name (string) – the internal name of the dictionary attribute, property of the request body.
name (string) – The dictionary attribute’s name, property of the request body.
dictionary_name – dictionaryName path parameter. the name of the dictionary the dictionary attribute belongs to.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(dictionary_name, allowed_values=None, data_type=None, description=None, direction_type=None, id=None, internal_name=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
-
get_network_access_dictionary_attribute_by_name
(dictionary_name, name, headers=None, **query_parameters)[source]¶ Get a Dictionary Attribute.
- Parameters
name (basestring) – name path parameter. the dictionary attribute name.
dictionary_name (basestring) – dictionaryName path parameter. the name of the dictionary the dictionary attribute belongs to.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_network_access_dictionary_attribute_by_name
(dictionary_name, name, allowed_values=None, data_type=None, description=None, direction_type=None, id=None, internal_name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Update a Dictionary Attribute.
- Parameters
allowed_values (list) – all of the allowed values for the dictionary attribute, property of the request body (list of objects).
data_type (string) – the data type for the dictionary attribute, property of the request body. Available values are ‘BOOLEAN’, ‘DATE’, ‘FLOAT’, ‘INT’, ‘IP’, ‘IPV4’, ‘IPV6’, ‘IPV6INTERFACE’, ‘IPV6PREFIX’, ‘LONG’, ‘OCTET_STRING’, ‘STRING’, ‘UINT64’ and ‘UNIT32’.
description (string) – The description of the Dictionary attribute, property of the request body.
dictionary_name (basestring) – the name of the dictionary which the dictionary attribute belongs to, property of the request body.
direction_type (string) – the direction for the useage of the dictionary attribute, property of the request body. Available values are ‘BOTH’, ‘IN’, ‘NONE’ and ‘OUT’.
id (string) – Identifier for the dictionary attribute, property of the request body.
internal_name (string) – the internal name of the dictionary attribute, property of the request body.
name (basestring) – The dictionary attribute’s name, property of the request body.
name – name path parameter. the dictionary attribute name.
dictionary_name – dictionaryName path parameter. the name of the dictionary the dictionary attribute belongs to.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_name
(dictionary_name, name, allowed_values=None, data_type=None, description=None, direction_type=None, id=None, internal_name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_network_access_dictionary_attribute_by_name
-
delete_network_access_dictionary_attribute_by_name
(dictionary_name, name, headers=None, **query_parameters)[source]¶ Delete a Dictionary Attribute.
- Parameters
name (basestring) – name path parameter. the dictionary attribute name.
dictionary_name (basestring) – dictionaryName path parameter. the name of the dictionary the dictionary attribute belongs to.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_name
(dictionary_name, name, headers=None, **query_parameters)[source]¶ Alias for delete_network_access_dictionary_attribute_by_name
-
network_access_dictionary_attributes_list¶
-
class
NetworkAccessDictionaryAttributesList
[source]¶ Identity Services Engine Network Access - Dictionary Attributes List API (version: 3.1.0).
Wraps the Identity Services Engine Network Access - Dictionary Attributes List API and exposes the API as native Python methods that return native Python objects.
-
get_network_access_dictionaries_authentication
(headers=None, **query_parameters)[source]¶ Network Access Returns list of dictionary attributes for authentication.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
Network Access Returns list of dictionary attributes for authorization.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_network_access_dictionaries_policy_set
(headers=None, **query_parameters)[source]¶ Network Access Returns list of dictionary attributes for policyset.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
network_access_identity_stores¶
-
class
NetworkAccessIdentityStores
[source]¶ Identity Services Engine Network Access - Identity Stores API (version: 3.1.0).
Wraps the Identity Services Engine Network Access - Identity Stores API and exposes the API as native Python methods that return native Python objects.
-
get_network_access_identity_stores
(headers=None, **query_parameters)[source]¶ Network Access Return list of identity stores for authentication policy definition. (Other CRUD APIs available throught ERS).
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(list): A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(headers=None, **query_parameters)[source]¶ Alias for get_network_access_identity_stores
-
network_access_network_conditions¶
-
class
NetworkAccessNetworkConditions
[source]¶ Identity Services Engine Network Access - Network Conditions API (version: 3.1.0).
Wraps the Identity Services Engine Network Access - Network Conditions API and exposes the API as native Python methods that return native Python objects.
-
get_network_access_network_conditions
(headers=None, **query_parameters)[source]¶ Network Access Returns a list of network conditions.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(headers=None, **query_parameters)[source]¶ Alias for get_network_access_network_conditions
-
create_network_access_network_condition
(condition_type=None, conditions=None, description=None, id=None, link=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Network Access Creates network condition.
- Parameters
condition_type (string) – This field determines the content of the conditions field, property of the request body. Available values are ‘DeviceCondition’, ‘DevicePortCondition’ and ‘EndstationCondition’.
conditions (list) – conditions, property of the request body (list of objects).
description (string) – description, property of the request body.
id (string) – id, property of the request body.
link (object) – link, property of the request body.
name (string) – Network Condition name, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(condition_type=None, conditions=None, description=None, id=None, link=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_network_access_network_condition
-
get_network_access_network_condition_by_id
(id, headers=None, **query_parameters)[source]¶ Network Access Returns a network condition.
- Parameters
id (basestring) – id path parameter. Condition id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_network_access_network_condition_by_id
(id, condition_type=None, conditions=None, description=None, link=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Network Access Update network condition.
- Parameters
condition_type (string) – This field determines the content of the conditions field, property of the request body. Available values are ‘DeviceCondition’, ‘DevicePortCondition’ and ‘EndstationCondition’.
conditions (list) – conditions, property of the request body (list of objects).
description (string) – description, property of the request body.
id (basestring) – id, property of the request body.
link (object) – link, property of the request body.
name (string) – Network Condition name, property of the request body.
id – id path parameter. Condition id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, condition_type=None, conditions=None, description=None, link=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
-
delete_network_access_network_condition_by_id
(id, headers=None, **query_parameters)[source]¶ Network Access Delete network condition.
- Parameters
id (basestring) – id path parameter. Condition id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
network_access_policy_set¶
-
class
NetworkAccessPolicySet
[source]¶ Identity Services Engine Network Access - Policy Set API (version: 3.1.0).
Wraps the Identity Services Engine Network Access - Policy Set API and exposes the API as native Python methods that return native Python objects.
-
get_network_access_policy_sets
(headers=None, **query_parameters)[source]¶ Get all network access policy sets.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(headers=None, **query_parameters)[source]¶ Alias for get_network_access_policy_sets
-
create_network_access_policy_set
(condition=None, default=None, description=None, hit_counts=None, id=None, is_proxy=None, link=None, name=None, rank=None, service_name=None, state=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Network Access Create a new policy set: Policy must include name , service identifier (either server sequence or allowed protocol) and a condition. Condition has hierarchical structure which define a set of condition for which policy could be match. Condition can be either reference to a stored Library condition, using model ConditionReference , or, dynamically built conditions which are not stored in the conditions Library, using models ConditionAttributes, ConditionAndBlock, ConditionOrBlock . .
- Parameters
condition (object) – condition, property of the request body.
default (boolean) – Flag which indicates if this policy set is the default one, property of the request body.
description (string) – The description for the policy set, property of the request body.
hit_counts (integer) – The amount of times the policy was matched, property of the request body.
id (string) – Identifier for the policy set, property of the request body.
is_proxy (boolean) – Flag which indicates if the policy set service is of type ‘Proxy Sequence’ or ‘Allowed Protocols’, property of the request body.
link (object) – link, property of the request body.
name (string) – Given name for the policy set, [Valid characters are alphanumerics, underscore, hyphen, space, period, parentheses], property of the request body.
rank (integer) – The rank(priority) in relation to other policy set. Lower rank is higher priority., property of the request body.
service_name (string) – Policy set service identifier Allowed Protocols,Server Sequence.., property of the request body.
state (string) – The state that the policy set is in. A disabled policy set cannot be matched., property of the request body. Available values are ‘disabled’, ‘enabled’ and ‘monitor’.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(condition=None, default=None, description=None, hit_counts=None, id=None, is_proxy=None, link=None, name=None, rank=None, service_name=None, state=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_network_access_policy_set
-
reset_hit_counts_network_access_policy_sets
(headers=None, **query_parameters)[source]¶ Network Access Reset HitCount for PolicySets.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_network_access_policy_set_by_id
(id, headers=None, **query_parameters)[source]¶ Network Access Get policy set attributes.
- Parameters
id (basestring) – id path parameter. Policy id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_network_access_policy_set_by_id
-
update_network_access_policy_set_by_id
(id, condition=None, default=None, description=None, hit_counts=None, is_proxy=None, link=None, name=None, rank=None, service_name=None, state=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Network Access Update a policy set.
- Parameters
condition (object) – condition, property of the request body.
default (boolean) – Flag which indicates if this policy set is the default one, property of the request body.
description (string) – The description for the policy set, property of the request body.
hit_counts (integer) – The amount of times the policy was matched, property of the request body.
id (basestring) – Identifier for the policy set, property of the request body.
is_proxy (boolean) – Flag which indicates if the policy set service is of type ‘Proxy Sequence’ or ‘Allowed Protocols’, property of the request body.
link (object) – link, property of the request body.
name (string) – Given name for the policy set, [Valid characters are alphanumerics, underscore, hyphen, space, period, parentheses], property of the request body.
rank (integer) – The rank(priority) in relation to other policy set. Lower rank is higher priority., property of the request body.
service_name (string) – Policy set service identifier Allowed Protocols,Server Sequence.., property of the request body.
state (string) – The state that the policy set is in. A disabled policy set cannot be matched., property of the request body. Available values are ‘disabled’, ‘enabled’ and ‘monitor’.
id – id path parameter. Policy id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, condition=None, default=None, description=None, hit_counts=None, is_proxy=None, link=None, name=None, rank=None, service_name=None, state=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_network_access_policy_set_by_id
-
delete_network_access_policy_set_by_id
(id, headers=None, **query_parameters)[source]¶ Network Access Delete a policy set.
- Parameters
id (basestring) – id path parameter. Policy id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_network_access_policy_set_by_id
-
network_access_profiles¶
-
class
NetworkAccessProfiles
[source]¶ Identity Services Engine Network Access - Profiles API (version: 3.1.0).
Wraps the Identity Services Engine Network Access - Profiles API and exposes the API as native Python methods that return native Python objects.
-
get_network_access_profiles
(headers=None, **query_parameters)[source]¶ Network Access Returns list of authorization profiles. (Other CRUD APIs available throught ERS).
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(list): A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(headers=None, **query_parameters)[source]¶ Alias for get_network_access_profiles
-
network_access_security_groups¶
-
class
NetworkAccessSecurityGroups
[source]¶ Identity Services Engine Network Access - Security Groups API (version: 3.1.0).
Wraps the Identity Services Engine Network Access - Security Groups API and exposes the API as native Python methods that return native Python objects.
-
get_network_access_security_groups
(headers=None, **query_parameters)[source]¶ Network Access Return list of available security groups for authorization policy definition. (Other CRUD APIs available throught ERS).
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(list): A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(headers=None, **query_parameters)[source]¶ Alias for get_network_access_security_groups
-
network_access_service_names¶
-
class
NetworkAccessServiceNames
[source]¶ Identity Services Engine Network Access - Service Names API (version: 3.1.0).
Wraps the Identity Services Engine Network Access - Service Names API and exposes the API as native Python methods that return native Python objects.
-
get_network_access_service_names
(headers=None, **query_parameters)[source]¶ Returns list of Allowed Protocols and Server Sequences for Network Access Policy Set results. ‘isLocalAuthorization’ property is available only for Network Access Policy Set results of type Server Sequence. (Other CRUD APIs available throught ERS).
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(list): A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(headers=None, **query_parameters)[source]¶ Alias for get_network_access_service_names
-
network_access_time_date_conditions¶
-
class
NetworkAccessTimeDateConditions
[source]¶ Identity Services Engine Network Access - Time/Date Conditions API (version: 3.1.0).
Wraps the Identity Services Engine Network Access - Time/Date Conditions API and exposes the API as native Python methods that return native Python objects.
-
get_network_access_time_conditions
(headers=None, **query_parameters)[source]¶ Network Access Returns a list of time and date conditions.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(headers=None, **query_parameters)[source]¶ Alias for get_network_access_time_conditions
-
create_network_access_time_condition
(attribute_name=None, attribute_value=None, children=None, condition_type=None, dates_range=None, dates_range_exception=None, description=None, dictionary_name=None, dictionary_value=None, hours_range=None, hours_range_exception=None, id=None, is_negate=None, link=None, name=None, operator=None, week_days=None, week_days_exception=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Network Access Creates time/date condition.
- Parameters
attribute_name (string) – Dictionary attribute name, property of the request body.
attribute_value (string) – Attribute value for condition Value type is specified in dictionary object if multiple values allowed is specified in dictionary object, property of the request body.
children (list) – In case type is andBlock or orBlock addtional conditions will be aggregated under this logical (OR/AND) condition, property of the request body (list of objects).
condition_type (string) – Inidicates whether the record is the condition itself(data) or a logical(or,and) aggregation Data type enum(reference,single) indicates than “conditonId” OR “ConditionAttrs” fields should contain condition data but not both Logical aggreation(and,or) enum indicates that additional conditions are present under the children field, property of the request body. Available values are ‘ConditionAndBlock’, ‘ConditionAttributes’, ‘ConditionOrBlock’, ‘ConditionReference’, ‘LibraryConditionAndBlock’, ‘LibraryConditionAttributes’, ‘LibraryConditionOrBlock’ and ‘TimeAndDateCondition’.
dates_range (object) – Defines for which date/s TimeAndDate condition will be matched Options are Date range, for specific date, the same date should be used for start/end date Default no specific dates In order to reset the dates to have no specific dates Date format yyyy- mm-dd (MM = month, dd = day, yyyy = year), property of the request body.
dates_range_exception (object) – Defines for which date/s TimeAndDate condition will be matched Options are Date range, for specific date, the same date should be used for start/end date Default no specific dates In order to reset the dates to have no specific dates Date format yyyy- mm-dd (MM = month, dd = day, yyyy = year), property of the request body.
description (string) – Condition description, property of the request body.
dictionary_name (string) – Dictionary name, property of the request body.
dictionary_value (string) – Dictionary value, property of the request body.
hours_range (object) – Defines for which hours a TimeAndDate condition will be matched Time format hh:mm ( h = hour , mm = minutes ) Default All Day , property of the request body.
hours_range_exception (object) – Defines for which hours a TimeAndDate condition will be matched Time format hh:mm ( h = hour , mm = minutes ) Default All Day , property of the request body.
id (string) – id, property of the request body.
is_negate (boolean) – Indicates whereas this condition is in negate mode, property of the request body.
link (object) – link, property of the request body.
name (string) – Condition name, property of the request body.
operator (string) – Equality operator, property of the request body. Available values are ‘contains’, ‘endsWith’, ‘equals’, ‘greaterOrEquals’, ‘greaterThan’, ‘in’, ‘ipEquals’, ‘ipGreaterThan’, ‘ipLessThan’, ‘ipNotEquals’, ‘lessOrEquals’, ‘lessThan’, ‘matches’, ‘notContains’, ‘notEndsWith’, ‘notEquals’, ‘notIn’, ‘notStartsWith’ and ‘startsWith’.
week_days (list) – Defines for which days this condition will be matched Days format Arrays of WeekDay enums Default List of All week days, property of the request body (list of strings. Available values are ‘Friday’, ‘Monday’, ‘Saturday’, ‘Sunday’, ‘Thursday’, ‘Tuesday’ and ‘Wednesday’).
week_days_exception (list) – Defines for which days this condition will NOT be matched Days format Arrays of WeekDay enums Default Not enabled, property of the request body (list of strings. Available values are ‘Friday’, ‘Monday’, ‘Saturday’, ‘Sunday’, ‘Thursday’, ‘Tuesday’ and ‘Wednesday’).
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(attribute_name=None, attribute_value=None, children=None, condition_type=None, dates_range=None, dates_range_exception=None, description=None, dictionary_name=None, dictionary_value=None, hours_range=None, hours_range_exception=None, id=None, is_negate=None, link=None, name=None, operator=None, week_days=None, week_days_exception=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_network_access_time_condition
-
get_network_access_time_condition_by_id
(id, headers=None, **query_parameters)[source]¶ Network Access returns a network condition.
- Parameters
id (basestring) – id path parameter. Condition id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_network_access_time_condition_by_id
-
update_network_access_time_condition_by_id
(id, attribute_name=None, attribute_value=None, children=None, condition_type=None, dates_range=None, dates_range_exception=None, description=None, dictionary_name=None, dictionary_value=None, hours_range=None, hours_range_exception=None, is_negate=None, link=None, name=None, operator=None, week_days=None, week_days_exception=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Network Access Update network condition.
- Parameters
attribute_name (string) – Dictionary attribute name, property of the request body.
attribute_value (string) – Attribute value for condition Value type is specified in dictionary object if multiple values allowed is specified in dictionary object, property of the request body.
children (list) – In case type is andBlock or orBlock addtional conditions will be aggregated under this logical (OR/AND) condition, property of the request body (list of objects).
condition_type (string) – Inidicates whether the record is the condition itself(data) or a logical(or,and) aggregation Data type enum(reference,single) indicates than “conditonId” OR “ConditionAttrs” fields should contain condition data but not both Logical aggreation(and,or) enum indicates that additional conditions are present under the children field, property of the request body. Available values are ‘ConditionAndBlock’, ‘ConditionAttributes’, ‘ConditionOrBlock’, ‘ConditionReference’, ‘LibraryConditionAndBlock’, ‘LibraryConditionAttributes’, ‘LibraryConditionOrBlock’ and ‘TimeAndDateCondition’.
dates_range (object) – Defines for which date/s TimeAndDate condition will be matched Options are Date range, for specific date, the same date should be used for start/end date Default no specific dates In order to reset the dates to have no specific dates Date format yyyy- mm-dd (MM = month, dd = day, yyyy = year), property of the request body.
dates_range_exception (object) – Defines for which date/s TimeAndDate condition will be matched Options are Date range, for specific date, the same date should be used for start/end date Default no specific dates In order to reset the dates to have no specific dates Date format yyyy- mm-dd (MM = month, dd = day, yyyy = year), property of the request body.
description (string) – Condition description, property of the request body.
dictionary_name (string) – Dictionary name, property of the request body.
dictionary_value (string) – Dictionary value, property of the request body.
hours_range (object) – Defines for which hours a TimeAndDate condition will be matched Time format hh:mm ( h = hour , mm = minutes ) Default All Day , property of the request body.
hours_range_exception (object) – Defines for which hours a TimeAndDate condition will be matched Time format hh:mm ( h = hour , mm = minutes ) Default All Day , property of the request body.
id (basestring) – id, property of the request body.
is_negate (boolean) – Indicates whereas this condition is in negate mode, property of the request body.
link (object) – link, property of the request body.
name (string) – Condition name, property of the request body.
operator (string) – Equality operator, property of the request body. Available values are ‘contains’, ‘endsWith’, ‘equals’, ‘greaterOrEquals’, ‘greaterThan’, ‘in’, ‘ipEquals’, ‘ipGreaterThan’, ‘ipLessThan’, ‘ipNotEquals’, ‘lessOrEquals’, ‘lessThan’, ‘matches’, ‘notContains’, ‘notEndsWith’, ‘notEquals’, ‘notIn’, ‘notStartsWith’ and ‘startsWith’.
week_days (list) – Defines for which days this condition will be matched Days format Arrays of WeekDay enums Default List of All week days, property of the request body (list of strings. Available values are ‘Friday’, ‘Monday’, ‘Saturday’, ‘Sunday’, ‘Thursday’, ‘Tuesday’ and ‘Wednesday’).
week_days_exception (list) – Defines for which days this condition will NOT be matched Days format Arrays of WeekDay enums Default Not enabled, property of the request body (list of strings. Available values are ‘Friday’, ‘Monday’, ‘Saturday’, ‘Sunday’, ‘Thursday’, ‘Tuesday’ and ‘Wednesday’).
id – id path parameter. Condition id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, attribute_name=None, attribute_value=None, children=None, condition_type=None, dates_range=None, dates_range_exception=None, description=None, dictionary_name=None, dictionary_value=None, hours_range=None, hours_range_exception=None, is_negate=None, link=None, name=None, operator=None, week_days=None, week_days_exception=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
-
delete_network_access_time_condition_by_id
(id, headers=None, **query_parameters)[source]¶ Network Access Delete Time/Date condition.
- Parameters
id (basestring) – id path parameter. Condition id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
network_device¶
-
class
NetworkDevice
[source]¶ Identity Services Engine NetworkDevice API (version: 3.1.0).
Wraps the Identity Services Engine NetworkDevice API and exposes the API as native Python methods that return native Python objects.
Network Device API allows the client to add, delete, update, and search network devices. Please note that each API description shows whether the API is supported in bulk operation. The bulk section is showing only ‘create’ bulk operation however, all other operation which are bulk supported can be used in same way.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
Revision Modification
Revision Modification
Attribute
Description
0
1.0
1.2
Initial Cisco ISE Version
1
1.1
2.0
Cisco ISE 2.0 model changes for TACACS+ and 3rd-Party support
tacacsSettings:sharedSecret
Added Attribute ‘sharedSecret’ for Tacacs+ support
tacacsSettings:connectModeOptions
Added Attribute ‘connectModeOptions’ for Tacacs+ support
profileName
Added Attribute ‘profileName’ for 3rd-Party support support
coaPort
Added Attribute ‘coaPort’ for 3rd-Party support support
2
1.2
2.4
Cisco ISE 2.4 model changes for Multi shared secret and DTLS Requierd support
authenticationsettings:enableMultiSecret
Added Attribute ‘enableMultiSecret’ for mulitple shared secret
authenticationsettings:secondRadiusSharedSecret
Added Attribute ‘secondRadiusSharedSecret’ for mulitple shared secret
authenticationsettings:dtlsRequired
Added Attribute ‘dtlsRequired’ for dtls settings
Resource Definition
Attribute
Type
Required
Description
Default Values
Example Values
name
String
Yes
Resource Name
ISE_EST_Local_Host
id
String
No
Resource UUID, mandatory for update
79aac430-7cc8-11eb-ad58-005056926583
description
String
No
example nd
authenticationSettings
List
Yes
enableKeyWrap
Boolean
Yes
false
enabled
Boolean
Yes
false
keyEncryptionKey
String
Yes
1234567890123456
keyInputFormat
Enum
Yes
Allowed values: ASCII, HEXADECIMAL
ASCII
messageAuthenticatorCodeKey
String
No
12345678901234567890
networkProtocol
Enum
No
Allowed values: RADIUS, TACACS_PLUS
RADIUS
radiusSharedSecret
String
No
VHEGKOCCUHYB
enableMultiSecret
Boolean
No
false
secondRadiusSharedSecret
String
No
dtlsRequired
Boolean
No
This value enforces use of dtls
false
coaPort
Integer
Yes
Since 2.0 (for 3rd party)
0
dtlsDnsName
String
No
This value is used to verify the client identity contained in the X.509 RADIUS/DTLS client certificate
ISE213.il.com
NetworkDeviceIPList
List
Yes
List of IP Subnets for this node
ipaddress
String
Yes
It can be either single IP address or IP range address
127.0.0.1
getIpaddressExclude
String
Yes
It can be either single IP address or IP range address
mask
Integer
Yes
32
NetworkDeviceGroupList
List
No
List of Network Device Group names for this node
[ “Location#All Locations”, “Device Type#All Device Types” ]
modelName
String
No
softwareVersion
String
No
profileName
String
Yes
Since 2.0 (for 3rd party)
true
Cisco
snmpsettings
List
Yes
linkTrapQuery
Boolean
Yes
SNMP link Trap Query
true
macTrapQuery
Boolean
Yes
SNMP MAC Trap Query
true
originatingPolicyServicesNode
String
Yes
Originating Policy Services Node
Auto
pollingInterval
Integer
Yes
SNMP Polling Interval in seconds (Valid Range 600 to 86400)
3600
roCommunity
String
No
SNMP RO Community
aaa
version
Enum
No
Allowed values: ONE, TWO_C, THREE
ONE
tacacsSettings
List
Yes
Since 2.0 (for Tacacs+)
connectModeOptions
Enum
No
Allowed values: OFF, ON_LEGACY, ON_DRAFT_COMPLIANT
ON_LEGACY
sharedSecret
String
Yes
Since 2.0
aaa
trustsecsettings
List
Yes
deviceAuthenticationSettings
List
Yes
sgaDeviceId
String
No
networkDevice1
sgaDevicePassword
String
No
aaa
deviceConfigurationDeployment
List
Yes
enableModePassword
String
No
aaa
execModePassword
String
No
aaa
execModeUsername
String
No
aaa
includeWhenDeployingSGTUpdates
Boolean
No
false
sgaNotificationAndUpdates
List
Yes
downlaodEnvironmentDataEveryXSeconds
Integer
No
86400
downlaodPeerAuthorizationPolicyEveryXSeconds
Integer
No
86400
downloadSGACLListsEveryXSeconds
Integer
No
86400
otherSGADevicesToTrustThisDevice
Boolean
No
false
reAuthenticationEveryXSeconds
Integer
No
86400
sendConfigurationToDevice
Boolean
No
false
sendConfigurationToDeviceUsing
Enum
No
Allowed values: ENABLE_USING_COA, ENABLE_USING_CLI, DISABLE_ALL
ENABLE_USING_COA
-
get_network_device_by_name
(name, headers=None, **query_parameters)[source]¶ This API allows the client to get a network device by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_name
(name, headers=None, **query_parameters)[source]¶ Alias for get_network_device_by_name
-
update_network_device_by_name
(name, authentication_settings=None, coa_port=None, description=None, dtls_dns_name=None, id=None, model_name=None, network_device_group_list=None, network_device_iplist=None, profile_name=None, snmpsettings=None, software_version=None, tacacs_settings=None, trustsecsettings=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update a network device by name.
- Parameters
network_device_group_list (list) – List of Network Device Group names for this node, property of the request body (list of strings).
network_device_iplist (list) – List of IP Subnets for this node, property of the request body (list of objects).
authentication_settings (object) – authenticationSettings, property of the request body.
coa_port (integer) – coaPort, property of the request body.
description (string) – description, property of the request body.
dtls_dns_name (string) – This value is used to verify the client identity contained in the X.509 RADIUS/DTLS client certificate, property of the request body.
id (string) – id, property of the request body.
model_name (string) – modelName, property of the request body.
name (basestring) – name, property of the request body.
profile_name (string) – profileName, property of the request body.
snmpsettings (object) – snmpsettings, property of the request body.
software_version (string) – softwareVersion, property of the request body.
tacacs_settings (object) – tacacsSettings, property of the request body.
trustsecsettings (object) – trustsecsettings, property of the request body.
name – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_name
(name, authentication_settings=None, coa_port=None, description=None, dtls_dns_name=None, id=None, model_name=None, network_device_group_list=None, network_device_iplist=None, profile_name=None, snmpsettings=None, software_version=None, tacacs_settings=None, trustsecsettings=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_network_device_by_name
-
delete_network_device_by_name
(name, headers=None, **query_parameters)[source]¶ This API deletes a network device by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_name
(name, headers=None, **query_parameters)[source]¶ Alias for delete_network_device_by_name
-
get_network_device_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get a network device by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_network_device_by_id
-
update_network_device_by_id
(id, authentication_settings=None, coa_port=None, description=None, dtls_dns_name=None, model_name=None, name=None, network_device_group_list=None, network_device_iplist=None, profile_name=None, snmpsettings=None, software_version=None, tacacs_settings=None, trustsecsettings=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update a network device by ID.
- Parameters
network_device_group_list (list) – List of Network Device Group names for this node, property of the request body (list of strings).
network_device_iplist (list) – List of IP Subnets for this node, property of the request body (list of objects).
authentication_settings (object) – authenticationSettings, property of the request body.
coa_port (integer) – coaPort, property of the request body.
description (string) – description, property of the request body.
dtls_dns_name (string) – This value is used to verify the client identity contained in the X.509 RADIUS/DTLS client certificate, property of the request body.
id (basestring) – id, property of the request body.
model_name (string) – modelName, property of the request body.
name (string) – name, property of the request body.
profile_name (string) – profileName, property of the request body.
snmpsettings (object) – snmpsettings, property of the request body.
software_version (string) – softwareVersion, property of the request body.
tacacs_settings (object) – tacacsSettings, property of the request body.
trustsecsettings (object) – trustsecsettings, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, authentication_settings=None, coa_port=None, description=None, dtls_dns_name=None, model_name=None, name=None, network_device_group_list=None, network_device_iplist=None, profile_name=None, snmpsettings=None, software_version=None, tacacs_settings=None, trustsecsettings=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_network_device_by_id
-
delete_network_device_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes a network device by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_network_device_by_id
-
get_network_device
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the network devices. Filter: [ipaddress, name, description, location, type] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_network_device
-
get_network_device_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the network devices. Filter: [ipaddress, name, description, location, type] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_network_device_generator
-
create_network_device
(authentication_settings=None, coa_port=None, description=None, dtls_dns_name=None, model_name=None, name=None, network_device_group_list=None, network_device_iplist=None, profile_name=None, snmpsettings=None, software_version=None, tacacs_settings=None, trustsecsettings=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates a network device.
- Parameters
network_device_group_list (list) – List of Network Device Group names for this node, property of the request body (list of strings).
network_device_iplist (list) – List of IP Subnets for this node, property of the request body (list of objects).
authentication_settings (object) – authenticationSettings, property of the request body.
coa_port (integer) – coaPort, property of the request body.
description (string) – description, property of the request body.
dtls_dns_name (string) – This value is used to verify the client identity contained in the X.509 RADIUS/DTLS client certificate, property of the request body.
model_name (string) – modelName, property of the request body.
name (string) – name, property of the request body.
profile_name (string) – profileName, property of the request body.
snmpsettings (object) – snmpsettings, property of the request body.
software_version (string) – softwareVersion, property of the request body.
tacacs_settings (object) – tacacsSettings, property of the request body.
trustsecsettings (object) – trustsecsettings, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(authentication_settings=None, coa_port=None, description=None, dtls_dns_name=None, model_name=None, name=None, network_device_group_list=None, network_device_iplist=None, profile_name=None, snmpsettings=None, software_version=None, tacacs_settings=None, trustsecsettings=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_network_device
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the network device.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
bulk_request_for_network_device
(operation_type=None, resource_media_type=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to submit the bulk request.
- Parameters
operation_type (string) – operationType, property of the request body.
resource_media_type (string) – resourceMediaType, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
bulk_request
(operation_type=None, resource_media_type=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for bulk_request_for_network_device
-
monitor_bulk_status_network_device
(bulkid, headers=None, **query_parameters)[source]¶ This API allows the client to monitor the bulk request.
- Parameters
bulkid (basestring) – bulkid path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
monitor_bulk_status
(bulkid, headers=None, **query_parameters)[source]¶ Alias for monitor_bulk_status_network_device
network_device_group¶
-
class
NetworkDeviceGroup
[source]¶ Identity Services Engine NetworkDeviceGroup API (version: 3.1.0).
Wraps the Identity Services Engine NetworkDeviceGroup API and exposes the API as native Python methods that return native Python objects.
Network Device Group API allows the client to search network device groups.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
1.3
Initial Cisco ISE Version
1
1.1
2.4
Added GetByName operation
Resource Definition
Attribute
Type
Required
Description
Example Values
name
String
Yes
Resource Name
Device Type#All Device Types
id
String
No
Resource UUID, mandatory for update
70c79c30-8bff-11e6-996c-525400b48521
description
String
No
All Device Types
othername
String
No
Device Type
-
get_network_device_group_by_name
(name, headers=None, **query_parameters)[source]¶ This API allows the client to get a network device group by name.
- Parameters
name (basestring) – name path parameter. colon is used as a separator instead of (#) in the NDG name. For example, if the name is a#b#c it should appear in the request URL as a:b:c.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_name
(name, headers=None, **query_parameters)[source]¶ Alias for get_network_device_group_by_name
-
get_network_device_group_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get a network device group by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_network_device_group_by_id
-
update_network_device_group_by_id
(id, description=None, name=None, othername=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update a network device group.
- Parameters
description (string) – description, property of the request body.
id (basestring) – id, property of the request body.
name (string) – name, property of the request body.
othername (string) – othername, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, description=None, name=None, othername=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_network_device_group_by_id
-
delete_network_device_group_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes a network device group.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_network_device_group_by_id
-
get_network_device_group
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the network device groups. Filter: [name, description, type] To search guest users by using toDate column,follow the format: DD- MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_network_device_group
-
get_network_device_group_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the network device groups. Filter: [name, description, type] To search guest users by using toDate column,follow the format: DD- MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_network_device_group_generator
-
create_network_device_group
(description=None, name=None, othername=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates a network device group.
- Parameters
description (string) – description, property of the request body.
name (string) – name, property of the request body.
othername (string) – othername, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(description=None, name=None, othername=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_network_device_group
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the network device group.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
node_deployment¶
-
class
NodeDeployment
[source]¶ Identity Services Engine Node Deployment API (version: 3.1.0).
Wraps the Identity Services Engine Node Deployment API and exposes the API as native Python methods that return native Python objects.
APIs for the configuration, administration and monitoring of the nodes in an ISE cluster deployment.
-
get_nodes
(headers=None, **query_parameters)[source]¶ Discovers all deployment nodes in the cluster. It provides basic information about each of deployed nodes in the cluster like Hostname, personas, status, roles and services. .
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
register_node
(administration=None, fdqn=None, general_settings=None, password=None, profile_configuration=None, user_name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Register ISE node to form a multi-node deployment .
- Parameters
administration (object) – administration, property of the request body.
fdqn (string) – fdqn, property of the request body. Constraints: maxLength set to 256 and minLength set to 1.
general_settings (object) – generalSettings, property of the request body.
password (string) – password, property of the request body.
profile_configuration (object) – profileConfiguration, property of the request body.
user_name (string) – userName, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
promote_node
(promotion_type=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Changes the cluster setting by promoting a node to primary when exceuted on standalone or secondary node. It could also be used to convert a deployment node to standalone node. .
- Parameters
promotion_type (string) – promotionType, property of the request body. Available values are ‘SECONDARY_TO_PRIMARY’, ‘STANDALONE_TO_PRIMARY’ and ‘TO_STANDALONE’.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_node_details
(hostname, headers=None, **query_parameters)[source]¶ It provides detailed information of the deployed node in the cluster. .
- Parameters
hostname (basestring) – hostname path parameter. ID of the existing deployed node.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(hostname, headers=None, **query_parameters)[source]¶ Alias for get_node_details
-
update_node
(hostname, general_settings=None, profile_configuration=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Updates the deployed ISE node with the information provided .
- Parameters
general_settings (object) – generalSettings, property of the request body.
profile_configuration (object) – profileConfiguration, property of the request body.
hostname (basestring) – hostname path parameter. ID of the existing deployed node.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_node
(hostname, headers=None, **query_parameters)[source]¶ The de-register ednode becomes a standalone Cisco ISE node. It retains the last configuration that it received rom the PrimaryPAN and assumes the default personas of a standalone node that are Administration, PolicyService, and Monitoring. .
- Parameters
hostname (basestring) – hostname path parameter. node name of the existing deployed node.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
node_group¶
-
class
NodeGroup
[source]¶ Identity Services Engine Node Group API (version: 3.1.0).
Wraps the Identity Services Engine Node Group API and exposes the API as native Python methods that return native Python objects.
APIs for the configuration, administration and monitoring of the nodes in an ISE cluster deployment.
-
get_node_groups
(headers=None, **query_parameters)[source]¶ Get details of all the node groups in the cluster. To detect node failure and to reset all URL-redirected sessions on the failed node, two or more Policy Service nodes can be placed in the same node group. When a node that belongs to a node group fails, another node in the same node group issues a Change of Authorization (CoA) for all URL-redirected sessions on the failed node.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_node_group
(node_group_name, headers=None, **query_parameters)[source]¶ Get details of a node group in the cluster.
- Parameters
node_group_name (basestring) – node-group-name path parameter. ID of the existing node group.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create_node_group
(node_group_name, description=None, mar_cache=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Developers need to create node group in the system.Node Group is a group of PSNs, mainly used for terminating posture pending sessions when a PSN in local node group fails.Node group members can communicate over TCP/7800.
- Parameters
description (string) – description, property of the request body. Constraints: maxLength set to 256 and minLength set to 1.
mar_cache (object) – mar-cache, property of the request body.
node_group_name (basestring) – node-group-name path parameter. ID of the existing node group.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_node_group
(node_group_name, description=None, mar_cache=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ API updates an existing node group in the system.
- Parameters
description (string) – description, property of the request body. Constraints: maxLength set to 256 and minLength set to 1.
mar_cache (object) – mar-cache, property of the request body.
node_group_name (basestring) – node-group-name path parameter. ID of the existing node group.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_node_group
(node_group_name, headers=None, **query_parameters)[source]¶ Developers need to delete node group in the system.
- Parameters
node_group_name (basestring) – node-group-name path parameter. ID of the existing node group.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
node_details¶
-
class
NodeDetails
[source]¶ Identity Services Engine NodeDetails API (version: 3.1.0).
Wraps the Identity Services Engine NodeDetails API and exposes the API as native Python methods that return native Python objects.
Node Details API allows the client to get deployment node details, get all nodes and filter nodes based on NodeServiceTypes.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
Revision Modification
Revision Modification
Attribute
Description
0
1.0
2.2
Initial Cisco ISE Version
1
1.1
2.4
Support Node Service Types as part of Node Object
NodeServiceTypes
Added String Field NodeServiceTypes. String represents services configured on the Node
2
1.2
2.7
Support Node FQDN as part of Node Object
fqdn
Added String Field FQDN. String represents FQDN of the Node
3
1.3
3.0
Support SXP IP Address as part of Node Details
sxpIpAddress
Added String Field sxpIpAddress. String represents SXP IP Address of the Node
Resource Definition
Attribute
Type
Required
Description
Example Values
name
String
Yes
Resource Name
TestNode
id
String
No
Resource UUID, mandatory for update
ab6deded-fcc2-47ff-8577-0014737c8fcf
description
String
No
gateWay
String
No
10.0.10.11
displayName
String
No
TestNode
inDeployment
Boolean
No
false
ipAddresses
String
No
[ “10.0.0.1”, “10.0.0.2” ]
otherPapFqdn
String
No
OtherTestNode
ipAddress
String
No
10.0.0.3
sxpIpAddress
String
No
10.10.10.1
nodeServiceTypes
String
No
DEVICE ADMIN
fqdn
String
No
test.ers.cisco.com
primaryPapNode
Boolean
No
true
papNode
Boolean
No
true
pxGridNode
Boolean
No
true
-
get_node_detail_by_name
(name, headers=None, **query_parameters)[source]¶ This API allows the client to get node details by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_name
(name, headers=None, **query_parameters)[source]¶ Alias for get_node_detail_by_name
-
get_node_detail_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get node details by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_node_detail_by_id
-
get_node_details
(filter=None, filter_type=None, page=None, size=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the node details. Filter: [nodeservicetypes] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 .
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_node_details
-
get_node_details_generator
(filter=None, filter_type=None, page=None, size=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the node details. Filter: [nodeservicetypes] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 .
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_node_details_generator
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information realted to the node details.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
pan_ha¶
-
class
PanHa
[source]¶ Identity Services Engine PAN HA API (version: 3.1.0).
Wraps the Identity Services Engine PAN HA API and exposes the API as native Python methods that return native Python objects.
APIs for the configuration, administration and monitoring of the nodes in an ISE cluster deployment.
-
get_pan_ha_status
(headers=None, **query_parameters)[source]¶ In a high availability configuration, the Primary Administration Node (PAN) is in the active state. The Secondary PAN (backup PAN) is in the standby state, which means it receives all configuration updates from the Primary PAN, but is not active in the ISE network. You can configure ISE to automatically the promote the secondary PAN when the primary PAN becomes unavailable.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
enable_pan_ha
(failed_attempts=None, is_enabled=None, polling_interval=None, primary_health_check_node=None, secondary_health_check_node=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ To deploy the auto-failover feature, you must have at least three nodes, where two of the nodes assume the Administration persona, and one node acts as the health check node. A health check node is a non-administration node and can be a Policy Service, Monitoring, or pxGrid node, or a combination of these. If the PANs are in different data centers, you must have a health check node for each PAN.
- Parameters
failed_attempts (integer) – failedAttempts, property of the request body.
is_enabled (boolean) – isEnabled, property of the request body.
polling_interval (integer) – pollingInterval, property of the request body.
primary_health_check_node (string) – primaryHealthCheckNode, property of the request body. Constraints: maxLength set to 64 and minLength set to 1.
secondary_health_check_node (string) – secondaryHealthCheckNode, property of the request body. Constraints: maxLength set to 64 and minLength set to 1.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
disable_pan_ha
(headers=None, **query_parameters)[source]¶ Disable the automatic PAN failover.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
portal_global_setting¶
-
class
PortalGlobalSetting
[source]¶ Identity Services Engine PortalGlobalSetting API (version: 3.1.0).
Wraps the Identity Services Engine PortalGlobalSetting API and exposes the API as native Python methods that return native Python objects.
The Portal Global Setting API allows the user to customize the text that is displayed in the Cisco ISE portals. This global setting controls whether HTML alone or both HTML and Javascript are permitted to be used in customized text.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.2
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Example Values
id
String
Yes
Resource UUID value
21013cb2-d030-4fb1-9ba2-35757634d770
customization
Enum
Yes
Allowed values: HTML, HTMLANDJAVASCRIPT
HTML
-
get_portal_global_setting_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get the portal global settings by id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_portal_global_setting_by_id
-
update_portal_global_setting_by_id
(id, customization=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update the portal global settings by id.
- Parameters
customization (string) – Allowed values: HTML, HTMLANDJAVASCRIPT, property of the request body.
id (basestring) – id, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, customization=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_portal_global_setting_by_id
-
get_portal_global_settings
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the portal global settings. Filter: [name] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_portal_global_settings
-
get_portal_global_settings_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the portal global settings. Filter: [name] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_portal_global_settings_generator
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the portal global setting .
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
portal_theme¶
-
class
PortalTheme
[source]¶ Identity Services Engine PortalTheme API (version: 3.1.0).
Wraps the Identity Services Engine PortalTheme API and exposes the API as native Python methods that return native Python objects.
Portal Theme API allows the client to add, delete, update and search Portal Theme among other operations which are available from all the portals.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.2
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Example Values
name
String
Yes
Resource Name
Default Blue theme
id
String
No
Resource UUID, mandatory for update
9eb421c0-8c01-11e6-996c-525400b48521
description
String
No
themeData
String
Yes
Portal Theme for all portals
Base 64 encoded string of CSS file
-
get_portal_theme_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get a portal theme by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_portal_theme_by_id
-
update_portal_theme_by_id
(id, description=None, name=None, theme_data=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update a portal theme by ID.
- Parameters
description (string) – description, property of the request body.
id (basestring) – id, property of the request body.
name (string) – name, property of the request body.
theme_data (string) – Portal Theme for all portals, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, description=None, name=None, theme_data=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_portal_theme_by_id
-
delete_portal_theme_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes a portal theme by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_portal_theme_by_id
-
get_portal_themes
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the portal themes. Filter: [name] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_portal_themes
-
get_portal_themes_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the portal themes. Filter: [name] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_portal_themes_generator
-
create_portal_theme
(description=None, name=None, theme_data=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates a portal theme.
- Parameters
description (string) – description, property of the request body.
name (string) – name, property of the request body.
theme_data (string) – Portal Theme for all portals, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(description=None, name=None, theme_data=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_portal_theme
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the portal theme.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
profiler¶
-
class
Profiler
[source]¶ Identity Services Engine Profiler API (version: 3.1.0).
Wraps the Identity Services Engine Profiler API and exposes the API as native Python methods that return native Python objects.
# Cisco ISE 3.0 pxGrid REST APIs
## License [Cisco Sample Code License](https://developer.cisco.com/site/license/cisco-sample-code-license/)
## Status These are the status icons for the requests so far. - ⌗ : must create resources to test - 🚧 : incomplete | untested - 🛑 : unsupported | bug
## Environment Variables This collection uses environment variables in scripts in the Tests tab to store data (id, name, portalId, etc.) between requests. This allows you to GET or POST then immediately GET {id} on a resource. Using No Environment will cause this convenience functionality to fail so be sure to choose one.
## Collection Variables This collection includes some default variables that you will want to update or override with environment variables for your ISE deployment. Specifically, you will want to set: - ise_pxg: the ISE PAN node name or IP address. Default: ise.securitydemo.net - rest_username: the username for ERS API access. Must be a member of SuperAdmin, ERSAdmin or ERSOperator groups. Default: admin which is the ISE SuperAdmin - rest_password: Default: C1sco12345
-
get_profiles
(headers=None, **query_parameters)[source]¶ 🚧 getProfiles.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
profiler_profile¶
-
class
ProfilerProfile
[source]¶ Identity Services Engine ProfilerProfile API (version: 3.1.0).
Wraps the Identity Services Engine ProfilerProfile API and exposes the API as native Python methods that return native Python objects.
Profiler Profile API allows the client to search profiles.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
1.2
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Example Values
name
String
Yes
Resource Name
2Wire-Device
id
String
No
Resource UUID, mandatory for update
fe8c7cc0-8bff-11e6-996c-525400b48521
description
String
No
Policy for 2Wire-Device
parentId
String
Yes
-
get_profiler_profile_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get a profiler profile by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_profiler_profile_by_id
-
get_profiler_profiles
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the profiler profiles. Filter: [name] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_profiler_profiles
-
get_profiler_profiles_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the profiler profiles. Filter: [name] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_profiler_profiles_generator
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the profiler profile.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
provider¶
-
class
Provider
[source]¶ Identity Services Engine Provider API (version: 3.1.0).
Wraps the Identity Services Engine Provider API and exposes the API as native Python methods that return native Python objects.
# Cisco ISE 3.0 pxGrid REST APIs
## License [Cisco Sample Code License](https://developer.cisco.com/site/license/cisco-sample-code-license/)
## Status These are the status icons for the requests so far. - ⌗ : must create resources to test - 🚧 : incomplete | untested - 🛑 : unsupported | bug
## Environment Variables This collection uses environment variables in scripts in the Tests tab to store data (id, name, portalId, etc.) between requests. This allows you to GET or POST then immediately GET {id} on a resource. Using No Environment will cause this convenience functionality to fail so be sure to choose one.
## Collection Variables This collection includes some default variables that you will want to update or override with environment variables for your ISE deployment. Specifically, you will want to set: - ise_pxg: the ISE PAN node name or IP address. Default: ise.securitydemo.net - rest_username: the username for ERS API access. Must be a member of SuperAdmin, ERSAdmin or ERSOperator groups. Default: admin which is the ISE SuperAdmin - rest_password: Default: C1sco12345
-
register_service
(name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ 🚧 ServiceRegister.
- Parameters
name (string) – name, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
unregister_service
(headers=None, **query_parameters)[source]¶ 🚧 ServiceUnregister.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
reregister_service
(headers=None, **query_parameters)[source]¶ 🚧 ServiceReregister.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
🚧 Authorization.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
psn_node_details_with_radius_service¶
-
class
PsnNodeDetailsWithRadiusService
[source]¶ Identity Services Engine PsnNodeDetailsWithRadiusService API (version: 3.1.0).
Wraps the Identity Services Engine PsnNodeDetailsWithRadiusService API and exposes the API as native Python methods that return native Python objects.
PSN Node Details with RADIUS Service API allows the client to get deployment node details where ‘Session Services’ is enabled.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.2
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Example Values
name
String
Yes
Resource Name
TestNode
id
String
No
Resource UUID, mandatory for update
ab6deded-fcc2-47ff-8577-0014737c8fcf
description
String
No
PSN with Session Service
ipAddress
String
Yes
10.0.0.1
-
get_session_service_node_by_name
(name, headers=None, **query_parameters)[source]¶ This API allows the client to get a PSN node details by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_name
(name, headers=None, **query_parameters)[source]¶ Alias for get_session_service_node_by_name
-
get_session_service_node_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get a PSN node details by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_session_service_node_by_id
-
get_session_service_node
(page=None, size=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the PSN node details.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_session_service_node
-
get_session_service_node_generator
(page=None, size=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the PSN node details.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_session_service_node_generator
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the PSN node.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
pull_deployment_info¶
-
class
PullDeploymentInfo
[source]¶ Identity Services Engine PullDeploymentInfo API (version: 3.1.0).
Wraps the Identity Services Engine PullDeploymentInfo API and exposes the API as native Python methods that return native Python objects.
Pull Deployment Info API allows clients to get the complete information about a Cisco ISE deployment. The information includes details about the deployment, network zccess, NADs, MDMs, licenses, posture and profiler.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.7
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
name
String
Yes
Resource Name
id
String
No
Resource UUID, mandatory for update
description
String
No
networkAccessInfo
List
No
networkAccessInfo Details
deploymentID
String
Yes
Deployment ID
isCsnEnabled
Boolean
Yes
false
nodeList
List
Yes
Node list
nodeAndScope
List
No
Includes ‘content’ which is an array of dictionaries describing various attributes with the properties:- name (String), - declaredType (String), - scope (String), - value (Varies), - nil (Boolean), - globalScope (Boolean), - typeSubstituted (Boolean)
sdaVNs
List
No
trustSecControl
String
No
ISE
radius3RdParty
List
No
profilerInfo
List
No
profilerInfo Details
deploymentID
String
Yes
Deployment ID
nodeList
List
Yes
Node list
node
List
No
Includes ‘profiles’ which is an array of dictionaries describing various attributes with the properties:- profile (List), - customProfilesCount (Integer), - endpointTypes (String), - totalProfilesCount (Integer), - uniqueEndpointsCount (Integer), - unknownEndpointsCount (Integer), - totalEndpointsCount (Integer), - unknownEndpointsPercentage (Integer)
deploymentInfo
List
No
deploymentInfo Details
deploymentID
String
Yes
Deployment ID
versionHistoryInfo
List
No
Array of dictionaries describing various attributes with the properties:- opType (String), - mainVersion (String), - epochTime (Integer)
nodeList
List
Yes
Node list
nodeAndNodeCountAndCountInfo
List
No
Includes ‘content’ which is an array of dictionaries describing various attributes with the properties:- name (String), - declaredType (String), - scope (String), - value (Varies), - nil (Boolean), - globalScope (Boolean), - typeSubstituted (Boolean)
fipsstatus
String
No
Disabled
nadInfo
List
No
nadInfo Details
deploymentID
String
Yes
Deployment ID
nodeList
List
Yes
Node list
nodeAndScope
List
No
Includes ‘content’ which is an array of dictionaries describing various attributes with the properties:- name (String), - declaredType (String), - scope (String), - value (List), - nil (Boolean), - globalScope (Boolean), - typeSubstituted (Boolean)
nadcountInfo
List
No
totalActiveNADCount
Integer
No
0
mdmInfo
List
No
mdmInfo Details
activeMdmServersCount
Integer
Yes
0
activeDesktopMdmServersCount
Integer
Yes
0
activeMobileMdmServersCount
Integer
Yes
0
deploymentID
String
Yes
Deployment ID
nodeList
List
Yes
Node list
nodeAndScope
List
No
Includes ‘content’ which is an array of dictionaries describing various attributes with the properties:- name (String), - declaredType (String), - scope (String), - value (Varies), - nil (Boolean), - globalScope (Boolean), - typeSubstituted (Boolean)
licensesInfo
List
No
licensesInfo Details
deploymentID
String
Yes
Deployment ID
nodeList
List
Yes
Node list
nodeAndScope
List
No
Includes ‘content’ which is an array of dictionaries describing various attributes with the properties:- name (String), - declaredType (String), - scope (String), - value (Varies), - nil (Boolean), - globalScope (Boolean), - typeSubstituted (Boolean)
postureInfo
List
No
postureInfo Details
content
List
Yes
Array of dictionaries describing various attributes with the properties:- name (String), - declaredType (String), - scope (String), - value (Varies), - nil (Boolean), - globalScope (Boolean), - typeSubstituted (Boolean)
kongInfo
List
No
kongInfo Details
deploymentID
String
Yes
Deployment ID
nodeList
List
Yes
Node list
node
List
No
Array of dictionaries describing various attributes with the properties:- sn (String), - service (List)
-
get_deployment_info
(timeout=None, headers=None, **query_parameters)[source]¶ This API allows the client to pull the deployment information.
- Parameters
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(timeout=None, headers=None, **query_parameters)[source]¶ Alias for get_deployment_info
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the pull deployment info.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
px_grid_settings¶
-
class
PxGridSettings
[source]¶ Identity Services Engine PxGridSettings API (version: 3.1.0).
Wraps the Identity Services Engine PxGridSettings API and exposes the API as native Python methods that return native Python objects.
pxGrid Settings API allows the client to change auto-approve settings for pxGrid nodes. Note: From Cisco ISE Release 3.1, all pxGrid connections must be based on pxGrid 2.0. pxGrid 1.0-based (XMPP-based) integrations will cease to work on Cisco ISE from Release 3.1 onwards. pxGrid Version 2.0, which is based on WebSockets, was introduced in Cisco ISE Release 2.4. We recommend that you plan and upgrade your other systems to pxGrid 2.0-compliant versions in order to prevent potential disruptions, if any, to integrations.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
3.0
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Default Values
Example Values
name
String
Yes
Resource Name
id
String
No
Resource UUID, mandatory for update
description
String
No
autoApproveCertBasedAccounts
Boolean
Yes
Auto approve certificate based accounts when true
false
true
allowPasswordBasedAccounts
Boolean
Yes
Allow password based acoounts when true
false
-
autoapprove_px_grid_settings
(allow_password_based_accounts=None, auto_approve_cert_based_accounts=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to auto approve the pxGrid settings.
- Parameters
allow_password_based_accounts (boolean) – Allow password based accounts when true, property of the request body.
auto_approve_cert_based_accounts (boolean) – Auto approve certificate based accounts when true, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
autoapprove
(allow_password_based_accounts=None, auto_approve_cert_based_accounts=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for autoapprove_px_grid_settings
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the pxGrid settings.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
radius_failure¶
-
class
RadiusFailure
[source]¶ Identity Services Engine RADIUS Failure API (version: 3.1.0).
Wraps the Identity Services Engine RADIUS Failure API and exposes the API as native Python methods that return native Python objects.
# Cisco ISE 3.0 pxGrid REST APIs
## License [Cisco Sample Code License](https://developer.cisco.com/site/license/cisco-sample-code-license/)
## Status These are the status icons for the requests so far. - ⌗ : must create resources to test - 🚧 : incomplete | untested - 🛑 : unsupported | bug
## Environment Variables This collection uses environment variables in scripts in the Tests tab to store data (id, name, portalId, etc.) between requests. This allows you to GET or POST then immediately GET {id} on a resource. Using No Environment will cause this convenience functionality to fail so be sure to choose one.
## Collection Variables This collection includes some default variables that you will want to update or override with environment variables for your ISE deployment. Specifically, you will want to set: - ise_pxg: the ISE PAN node name or IP address. Default: ise.securitydemo.net - rest_username: the username for ERS API access. Must be a member of SuperAdmin, ERSAdmin or ERSOperator groups. Default: admin which is the ISE SuperAdmin - rest_password: Default: C1sco12345
-
get_failures
(headers=None, **query_parameters)[source]¶ 🚧 getFailures.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
radius_server_sequence¶
-
class
RadiusServerSequence
[source]¶ Identity Services Engine RADIUSServerSequence API (version: 3.1.0).
Wraps the Identity Services Engine RADIUSServerSequence API and exposes the API as native Python methods that return native Python objects.
RADIUS Server Sequence API allows the client to add, delete, update, search and perform actions on RADIUS server sequence.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.3
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Default Values
Example Values
name
String
Yes
Resource Name
name
id
String
No
Resource UUID, mandatory for update
ab6deded-fcc2-47ff-8577-0014737c8fcf
description
String
No
description
stripPrefix
Boolean
No
false
stripSuffix
Boolean
No
false
prefixSeparator
String
No
The prefixSeparator is required only if stripPrefix is true. The maximum length is 1 character
suffixSeparator
String
No
The suffixSeparator is required only if stripSuffix is true. The maximum length is 1 character
@
remoteAccounting
Boolean
No
true
localAccounting
Boolean
No
false
useAttrSetOnRequest
Boolean
No
false
useAttrSetBeforeAcc
Boolean
No
false
continueAuthorzPolicy
Boolean
No
false
radiusServers
List
Yes
List with names of external radius server. The order of the names in the list is the order of servers that will be used during authentication
[ “externalRadiusServer1”, “externalRadiusServer2” ]
onRequestAttrManipulators
List
No
The onRequestAttrManipulators is required only if useAttrSetOnRequest is true
AttributeManipulator
List
No
action
Enum
Yes
Allowed Values: ADD, UPDATE, REMOVE, REMOVEANY
ADD
dictionaryName
String
Yes
Cisco
attributeName
String
Yes
cisco-prev-hop-ip
value
String
Yes
test1
changedVal
String
No
The changedVal is required only if the action equals to ‘UPDATE’
test2
beforeAcceptAttrManipulators
List
No
The beforeAcceptAttrManipulators is required only if useAttrSetBeforeAcc is true
AttributeManipulator
List
No
action
Enum
Yes
Allowed Values: ADD, UPDATE, REMOVE, REMOVEANY
ADD
dictionaryName
String
Yes
Cisco
attributeName
String
Yes
cisco-prev-hop-ip
value
String
Yes
test1
changedVal
String
No
The changedVal is required only if the action equals to ‘UPDATE’
test2
-
get_radius_server_sequence_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get a RADIUS server sequence by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_radius_server_sequence_by_id
-
update_radius_server_sequence_by_id
(id, before_accept_attr_manipulators_list=None, continue_authorz_policy=None, description=None, local_accounting=None, name=None, on_request_attr_manipulator_list=None, prefix_separator=None, radius_server_list=None, remote_accounting=None, strip_prefix=None, strip_suffix=None, suffix_separator=None, use_attr_set_before_acc=None, use_attr_set_on_request=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update a RADIUS server sequence.
- Parameters
before_accept_attr_manipulators_list (list) – The beforeAcceptAttrManipulators is required only if useAttrSetBeforeAcc is true, property of the request body (list of objects).
on_request_attr_manipulator_list (list) – The onRequestAttrManipulators is required only if useAttrSetOnRequest is true, property of the request body (list of objects).
radius_server_list (list) – RadiusServerList, property of the request body (list of strings).
continue_authorz_policy (boolean) – continueAuthorzPolicy, property of the request body.
description (string) – description, property of the request body.
id (basestring) – id, property of the request body.
local_accounting (boolean) – localAccounting, property of the request body.
name (string) – name, property of the request body.
prefix_separator (string) – The prefixSeparator is required only if stripPrefix is true. The maximum length is 1 character, property of the request body.
remote_accounting (boolean) – remoteAccounting, property of the request body.
strip_prefix (boolean) – stripPrefix, property of the request body.
strip_suffix (boolean) – stripSuffix, property of the request body.
suffix_separator (string) – The suffixSeparator is required only if stripSuffix is true. The maximum length is 1 character, property of the request body.
use_attr_set_before_acc (boolean) – useAttrSetBeforeAcc, property of the request body.
use_attr_set_on_request (boolean) – useAttrSetOnRequest, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, before_accept_attr_manipulators_list=None, continue_authorz_policy=None, description=None, local_accounting=None, name=None, on_request_attr_manipulator_list=None, prefix_separator=None, radius_server_list=None, remote_accounting=None, strip_prefix=None, strip_suffix=None, suffix_separator=None, use_attr_set_before_acc=None, use_attr_set_on_request=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_radius_server_sequence_by_id
-
delete_radius_server_sequence_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes a RADIUS server sequence.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_radius_server_sequence_by_id
-
get_radius_server_sequence
(page=None, size=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the RADIUS server sequences.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_radius_server_sequence
-
get_radius_server_sequence_generator
(page=None, size=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the RADIUS server sequences.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_radius_server_sequence_generator
-
create_radius_server_sequence
(before_accept_attr_manipulators_list=None, continue_authorz_policy=None, description=None, local_accounting=None, name=None, on_request_attr_manipulator_list=None, prefix_separator=None, radius_server_list=None, remote_accounting=None, strip_prefix=None, strip_suffix=None, suffix_separator=None, use_attr_set_before_acc=None, use_attr_set_on_request=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates a RADIUS server sequence.
- Parameters
before_accept_attr_manipulators_list (list) – The beforeAcceptAttrManipulators is required only if useAttrSetBeforeAcc is true, property of the request body (list of objects).
on_request_attr_manipulator_list (list) – The onRequestAttrManipulators is required only if useAttrSetOnRequest is true, property of the request body (list of objects).
radius_server_list (list) – RadiusServerList, property of the request body (list of strings).
continue_authorz_policy (boolean) – continueAuthorzPolicy, property of the request body.
description (string) – description, property of the request body.
local_accounting (boolean) – localAccounting, property of the request body.
name (string) – name, property of the request body.
prefix_separator (string) – The prefixSeparator is required only if stripPrefix is true. The maximum length is 1 character, property of the request body.
remote_accounting (boolean) – remoteAccounting, property of the request body.
strip_prefix (boolean) – stripPrefix, property of the request body.
strip_suffix (boolean) – stripSuffix, property of the request body.
suffix_separator (string) – The suffixSeparator is required only if stripSuffix is true. The maximum length is 1 character, property of the request body.
use_attr_set_before_acc (boolean) – useAttrSetBeforeAcc, property of the request body.
use_attr_set_on_request (boolean) – useAttrSetOnRequest, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(before_accept_attr_manipulators_list=None, continue_authorz_policy=None, description=None, local_accounting=None, name=None, on_request_attr_manipulator_list=None, prefix_separator=None, radius_server_list=None, remote_accounting=None, strip_prefix=None, strip_suffix=None, suffix_separator=None, use_attr_set_before_acc=None, use_attr_set_on_request=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_radius_server_sequence
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the RADIUS server sequence.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
restid_store¶
-
class
RestidStore
[source]¶ Identity Services Engine RESTIDStore API (version: 3.1.0).
Wraps the Identity Services Engine RESTIDStore API and exposes the API as native Python methods that return native Python objects.
REST ID Store API allows clients to add, get, update and delete REST ID stores.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
3.0
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Example Values
name
String
Yes
Resource Name
RestIdStore1
id
String
No
Resource UUID, mandatory for update
b1155994-b736-46af-9add-04bed3058e3a
description
String
No
Object that represents the restID storee
ersRestIDStoreAttributes
List
Yes
Holds the attributes of the restID object
usernameSuffix
String
Yes
Suffix of the username domain
@place.com
rootUrl
String
Yes
url of the root of the RestIDStore
rootUrl
predefined
Enum
Yes
The cloud provider connected to of the RestIDStore. Options are: - Azure, - Okta, - None
Azure
headers
List
Yes
Headers for the RestIDStore
key
String
Yes
Key of the header
tenantID
value
String
Yes
Value of the header
tenantID_value
-
get_rest_id_store_by_name
(name, headers=None, **query_parameters)[source]¶ This API allows the client to get a REST ID store by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_name
(name, headers=None, **query_parameters)[source]¶ Alias for get_rest_id_store_by_name
-
update_rest_id_store_by_name
(name, description=None, ers_rest_idstore_attributes=None, id=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update a REST ID store by name.
- Parameters
description (string) – description, property of the request body.
ers_rest_idstore_attributes (object) – ersRestIDStoreAttributes, property of the request body.
id (string) – id, property of the request body.
name (basestring) – name, property of the request body.
name – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_name
(name, description=None, ers_rest_idstore_attributes=None, id=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_rest_id_store_by_name
-
delete_rest_id_store_by_name
(name, headers=None, **query_parameters)[source]¶ This API deletes a REST ID store by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_name
(name, headers=None, **query_parameters)[source]¶ Alias for delete_rest_id_store_by_name
-
get_rest_id_store_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get a REST ID store by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_rest_id_store_by_id
-
update_rest_id_store_by_id
(id, description=None, ers_rest_idstore_attributes=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update a REST ID store.
- Parameters
description (string) – description, property of the request body.
ers_rest_idstore_attributes (object) – ersRestIDStoreAttributes, property of the request body.
id (basestring) – id, property of the request body.
name (string) – name, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, description=None, ers_rest_idstore_attributes=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_rest_id_store_by_id
-
delete_rest_id_store_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes a REST ID store.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_rest_id_store_by_id
-
get_rest_id_store
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the REST ID stores. Filter: [name] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_rest_id_store
-
get_rest_id_store_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the REST ID stores. Filter: [name] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_rest_id_store_generator
-
create_rest_id_store
(description=None, ers_rest_idstore_attributes=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates a REST ID store.
- Parameters
description (string) – description, property of the request body.
ers_rest_idstore_attributes (object) – ersRestIDStoreAttributes, property of the request body.
name (string) – name, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(description=None, ers_rest_idstore_attributes=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_rest_id_store
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the REST ID store.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
replication_status¶
-
class
ReplicationStatus
[source]¶ Identity Services Engine Replication Status API (version: 3.1.0).
Wraps the Identity Services Engine Replication Status API and exposes the API as native Python methods that return native Python objects.
APIs for the configuration, administration and monitoring of the nodes in an ISE cluster deployment.
-
get_node_replication_status
(node, headers=None, **query_parameters)[source]¶ Retrives replication status of a node.
- Parameters
node (basestring) – node path parameter. ID of the existing node.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
repository¶
-
class
Repository
[source]¶ Identity Services Engine Repository API (version: 3.1.0).
Wraps the Identity Services Engine Repository API and exposes the API as native Python methods that return native Python objects.
-
get_repositories
(headers=None, **query_parameters)[source]¶ This will get the full list of repository definitions on the system. .
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(headers=None, **query_parameters)[source]¶ Alias for get_repositories
-
create_repository
(enable_pki=None, name=None, password=None, path=None, protocol=None, server_name=None, user_name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Create a new repository in the system. The name provided for the repository must be unique. .
- Parameters
enable_pki (boolean) – enablePki, property of the request body.
name (string) – Repository name should be less than 80 characters and can contain alphanumeric, underscore, hyphen and dot characters., property of the request body.
password (string) – Password can contain alphanumeric and/or special characters., property of the request body.
path (string) – Path should always start with “/” and can contain alphanumeric, underscore, hyphen and dot characters., property of the request body.
protocol (string) – protocol, property of the request body. Available values are ‘CDROM’, ‘DISK’, ‘FTP’, ‘HTTP’, ‘HTTPS’, ‘NFS’, ‘SFTP’ and ‘TFTP’.
server_name (string) – serverName, property of the request body.
user_name (string) – Username may contain alphanumeric and _-./@$ characters., property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(enable_pki=None, name=None, password=None, path=None, protocol=None, server_name=None, user_name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_repository
-
get_repository
(name, headers=None, **query_parameters)[source]¶ Get a specific repository identified by the name passed in the URL. .
- Parameters
name (basestring) – name path parameter. Unique name for a repository.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_name
(name, headers=None, **query_parameters)[source]¶ Alias for get_repository
-
update_repository
(name, enable_pki=None, password=None, path=None, protocol=None, server_name=None, user_name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Update the definition of a specific repository, providing ALL parameters for the repository. .
- Parameters
enable_pki (boolean) – enablePki, property of the request body.
name (basestring) – Repository name should be less than 80 characters and can contain alphanumeric, underscore, hyphen and dot characters., property of the request body.
password (string) – Password can contain alphanumeric and/or special characters., property of the request body.
path (string) – Path should always start with “/” and can contain alphanumeric, underscore, hyphen and dot characters., property of the request body.
protocol (string) – protocol, property of the request body. Available values are ‘CDROM’, ‘DISK’, ‘FTP’, ‘HTTP’, ‘HTTPS’, ‘NFS’, ‘SFTP’ and ‘TFTP’.
server_name (string) – serverName, property of the request body.
user_name (string) – Username may contain alphanumeric and _-./@$ characters., property of the request body.
name – name path parameter. Unique name for a repository.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_name
(name, enable_pki=None, password=None, path=None, protocol=None, server_name=None, user_name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_repository
-
delete_repository
(name, headers=None, **query_parameters)[source]¶ Long description TBD .
- Parameters
name (basestring) – name path parameter. Unique name for a repository.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_name
(name, headers=None, **query_parameters)[source]¶ Alias for delete_repository
-
get_repository_files
(name, headers=None, **query_parameters)[source]¶ This will get the full list of files present in the named repository. .
- Parameters
name (basestring) – name path parameter. Unique name for a repository.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_files
(name, headers=None, **query_parameters)[source]¶ Alias for get_repository_files
-
sms_provider¶
-
class
SmsProvider
[source]¶ Identity Services Engine SMSProvider API (version: 3.1.0).
Wraps the Identity Services Engine SMSProvider API and exposes the API as native Python methods that return native Python objects.
SMS Provider API allows the client to search the SMS providers configured from Cisco ISE GUI.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.2
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Example Values
name
String
Yes
Resource Name
name
id
String
No
Resource UUID, mandatory for update
b1155994-b736-46af-9add-04bed3058e3a
description
String
No
-
get_sms_provider
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the SMS providers. Filter: [name] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_sms_provider
-
get_sms_provider_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the SMS providers. Filter: [name] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_sms_provider_generator
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the SMS provider.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
sxp_connections¶
-
class
SxpConnections
[source]¶ Identity Services Engine SXPConnections API (version: 3.1.0).
Wraps the Identity Services Engine SXPConnections API and exposes the API as native Python methods that return native Python objects.
SXP Connections API allows clients to add, get, update and delete the Security Group Tag (SGT) Exchange Protocol (SXP) connections.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
Revision Modification
Revision Modification
Attribute
Description
0
1.0
2.0
Initial Cisco ISE Version
1
1.1
3.0
Cisco ISE 3.0 model changes
sxpVpn
Attribute can include some VPNs separated by comma
Resource Definition
Attribute
Type
Required
Description
Example Values
name
String
Yes
Resource Name
id
String
No
Resource UUID value
f9269682-dcaf-11e3-ad0a-5bdcd2d9fd69
description
String
No
Brief description about network peer
sxpPeer
String
Yes
Sxp Peer Name
sxpVpn
String
Yes
Sxp VPN Name
sxpNode
String
Yes
Sxp Node Name
ipAddress
String
Yes
Sxp Peer IP address
sxpMode
String
Yes
Sxp Mode
sxpVersion
String
Yes
Sxp Version
enabled
Boolean
Yes
true
-
get_sxp_connections_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get a SXP connection by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_sxp_connections_by_id
-
update_sxp_connections_by_id
(id, description=None, enabled=None, ip_address=None, sxp_mode=None, sxp_node=None, sxp_peer=None, sxp_version=None, sxp_vpn=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update a SXP connection.
- Parameters
description (string) – description, property of the request body.
enabled (boolean) – enabled, property of the request body.
id (basestring) – id, property of the request body.
ip_address (string) – ipAddress, property of the request body.
sxp_mode (string) – sxpMode, property of the request body.
sxp_node (string) – sxpNode, property of the request body.
sxp_peer (string) – sxpPeer, property of the request body.
sxp_version (string) – sxpVersion, property of the request body.
sxp_vpn (string) – sxpVpn, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, description=None, enabled=None, ip_address=None, sxp_mode=None, sxp_node=None, sxp_peer=None, sxp_version=None, sxp_vpn=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_sxp_connections_by_id
-
delete_sxp_connections_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes a SXP connection.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_sxp_connections_by_id
-
get_sxp_connections
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the SXP connections. Filter: [name, description] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_sxp_connections
-
get_sxp_connections_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the SXP connections. Filter: [name, description] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_sxp_connections_generator
-
create_sxp_connections
(description=None, enabled=None, ip_address=None, sxp_mode=None, sxp_node=None, sxp_peer=None, sxp_version=None, sxp_vpn=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates a SXP connection.
- Parameters
description (string) – description, property of the request body.
enabled (boolean) – enabled, property of the request body.
ip_address (string) – ipAddress, property of the request body.
sxp_mode (string) – sxpMode, property of the request body.
sxp_node (string) – sxpNode, property of the request body.
sxp_peer (string) – sxpPeer, property of the request body.
sxp_version (string) – sxpVersion, property of the request body.
sxp_vpn (string) – sxpVpn, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(description=None, enabled=None, ip_address=None, sxp_mode=None, sxp_node=None, sxp_peer=None, sxp_version=None, sxp_vpn=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_sxp_connections
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the SXP connections.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
bulk_request_for_sxp_connections
(operation_type=None, resource_media_type=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to submit the bulk request.
- Parameters
operation_type (string) – operationType, property of the request body.
resource_media_type (string) – resourceMediaType, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
bulk_request
(operation_type=None, resource_media_type=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for bulk_request_for_sxp_connections
-
monitor_bulk_status_sxp_connections
(bulkid, headers=None, **query_parameters)[source]¶ This API allows the client to monitor the bulk request.
- Parameters
bulkid (basestring) – bulkid path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
monitor_bulk_status
(bulkid, headers=None, **query_parameters)[source]¶ Alias for monitor_bulk_status_sxp_connections
-
sxp_local_bindings¶
-
class
SxpLocalBindings
[source]¶ Identity Services Engine SXPLocalBindings API (version: 3.1.0).
Wraps the Identity Services Engine SXPLocalBindings API and exposes the API as native Python methods that return native Python objects.
SXP Local Bindings API allows clients to add, get, update and delete SGT static mappings.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
Revision Modification
Revision Modification
Attribute
Description
0
1.0
2.0
Initial Cisco ISE Version
1
1.1
3.0
Cisco ISE 3.0 model changes
vns
Added new property for the Virtual Networks
Resource Definition
Attribute
Type
Required
Description
Example Values
name
String
Yes
Resource Name
id
String
No
Resource UUID value
f9269682-dcaf-11e3-ad0a-5bdcd2d9fd69
description
String
No
bindingName
String
No
This field is depricated from Cisco ISE 3.0
ipAddressOrHost
String
Yes
IP address for static mapping (hostname is not supported)
ipAddressOrHost
sgt
String
Yes
SGT name or ID
sgt_id
sxpVpn
String
Yes
List of SXP Domains, separated with comma. At least one of: sxpVpn or vns should be defined
Sxp Vpn Name
vns
String
Yes
List of Virtual Networks, separated with comma. At least one of: sxpVpn or vns should be defined
virtualNetwork
-
get_sxp_local_bindings_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get a SXP local binding by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_sxp_local_bindings_by_id
-
update_sxp_local_bindings_by_id
(id, binding_name=None, description=None, ip_address_or_host=None, sgt=None, sxp_vpn=None, vns=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update a SXP local binding.
- Parameters
binding_name (string) – This field is depricated from Cisco ISE 3.0, property of the request body.
description (string) – description, property of the request body.
id (basestring) – id, property of the request body.
ip_address_or_host (string) – IP address for static mapping (hostname is not supported), property of the request body.
sgt (string) – SGT name or ID, property of the request body.
sxp_vpn (string) – List of SXP Domains, separated with comma. At least one of: sxpVpn or vns should be defined, property of the request body.
vns (string) – List of Virtual Networks, separated with comma. At least one of: sxpVpn or vns should be defined, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, binding_name=None, description=None, ip_address_or_host=None, sgt=None, sxp_vpn=None, vns=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_sxp_local_bindings_by_id
-
delete_sxp_local_bindings_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes a SXP local binding.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_sxp_local_bindings_by_id
-
get_sxp_local_bindings
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the SXP local bindings. Filter: [name, description] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_sxp_local_bindings
-
get_sxp_local_bindings_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the SXP local bindings. Filter: [name, description] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_sxp_local_bindings_generator
-
create_sxp_local_bindings
(binding_name=None, description=None, id=None, ip_address_or_host=None, sgt=None, sxp_vpn=None, vns=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates a SXP local binding.
- Parameters
binding_name (string) – This field is depricated from Cisco ISE 3.0, property of the request body.
description (string) – description, property of the request body.
id (string) – id, property of the request body.
ip_address_or_host (string) – IP address for static mapping (hostname is not supported), property of the request body.
sgt (string) – SGT name or ID, property of the request body.
sxp_vpn (string) – List of SXP Domains, separated with comma. At least one of: sxpVpn or vns should be defined, property of the request body.
vns (string) – List of Virtual Networks, separated with comma. At least one of: sxpVpn or vns should be defined, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(binding_name=None, description=None, id=None, ip_address_or_host=None, sgt=None, sxp_vpn=None, vns=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_sxp_local_bindings
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the SXP local bindings.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
bulk_request_for_sxp_local_bindings
(operation_type=None, resource_media_type=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to submit the bulk request.
- Parameters
operation_type (string) – operationType, property of the request body.
resource_media_type (string) – resourceMediaType, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
bulk_request
(operation_type=None, resource_media_type=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for bulk_request_for_sxp_local_bindings
-
monitor_bulk_status_sxp_local_bindings
(bulkid, headers=None, **query_parameters)[source]¶ This API allows the client to monitor the bulk request.
- Parameters
bulkid (basestring) – bulkid path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
monitor_bulk_status
(bulkid, headers=None, **query_parameters)[source]¶ Alias for monitor_bulk_status_sxp_local_bindings
-
sxp_vpns¶
-
class
SxpVpns
[source]¶ Identity Services Engine SXPVPNs API (version: 3.1.0).
Wraps the Identity Services Engine SXPVPNs API and exposes the API as native Python methods that return native Python objects.
SXP VPNs API allows clients to add, get and delete SXP VPNs (SXP Domains).Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.0
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Example Values
name
String
Yes
Resource Name
id
String
No
Resource UUID value
ef36ca16-0cf7-4806-b2a9-6f547cfe4805
description
String
No
sxpVpnName
String
Yes
default
-
get_sxp_vpn_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get a SXP VPN by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_sxp_vpn_by_id
-
delete_sxp_vpn_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes a SXP VPN.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_sxp_vpn_by_id
-
get_sxp_vpns
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the SXP VPNs. Filter: [name, description] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_sxp_vpns
-
get_sxp_vpns_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the SXP VPNs. Filter: [name, description] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_sxp_vpns_generator
-
create_sxp_vpn
(sxp_vpn_name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates a SXP VPN.
- Parameters
sxp_vpn_name (string) – sxpVpnName, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(sxp_vpn_name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_sxp_vpn
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the SXP VPNs.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
bulk_request_for_sxp_vpns
(operation_type=None, resource_media_type=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to submit the bulk request.
- Parameters
operation_type (string) – operationType, property of the request body.
resource_media_type (string) – resourceMediaType, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
bulk_request
(operation_type=None, resource_media_type=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for bulk_request_for_sxp_vpns
-
monitor_bulk_status_sxp_vpns
(bulkid, headers=None, **query_parameters)[source]¶ This API allows the client to monitor the bulk request.
- Parameters
bulkid (basestring) – bulkid path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
monitor_bulk_status
(bulkid, headers=None, **query_parameters)[source]¶ Alias for monitor_bulk_status_sxp_vpns
-
security_group_to_virtual_network¶
-
class
SecurityGroupToVirtualNetwork
[source]¶ Identity Services Engine SecurityGroupToVirtualNetwork API (version: 3.1.0).
Wraps the Identity Services Engine SecurityGroupToVirtualNetwork API and exposes the API as native Python methods that return native Python objects.
SGT mapping to virtual networks are mapped to referenced vlan. These constructs come from out side of Cisco ISE and are not CRUDable inside Cisco ISE.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.3
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Example Values
name
String
Yes
Resource Name
name
id
String
No
Resource UUID, mandatory for update
1af3d6e2-cc3b-4603-b80f-6827768335ab
description
String
No
description
sgtId
String
No
sgt_id
virtualnetworklist
List
No
Includes ‘vlans’ which is an array of dictionaries describing various attributes with the properties: - id (String), - name (String), - description (String), - defaultVlan (Boolean), - maxValue (Integer), - data (Boolean)
“id” : “1af3d6e2-cc3b-4603-b80f-6827768335ab”, “name” : “virtual1”, “description” : “description”, “defaultVirtualNetwork” : false, “vlans” : [ { “id” : “1af3d6e2-cc3b-4603-b80f-6827768335ab”, “name” : “vlan1”, “description” : “description1”, “defaultVlan” : true, “maxValue” : 1882725260, “data” : true } ] } ]
-
get_security_groups_to_vn_to_vlan_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get a security group to virtual network by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_security_groups_to_vn_to_vlan_by_id
-
update_security_groups_to_vn_to_vlan_by_id
(id, description=None, name=None, sgt_id=None, virtualnetworklist=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update a security group to virtual network.
- Parameters
description (string) – description, property of the request body.
id (basestring) – id, property of the request body.
name (string) – name, property of the request body.
sgt_id (string) – sgtId, property of the request body.
virtualnetworklist (list) – virtualnetworklist, property of the request body (list of objects).
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, description=None, name=None, sgt_id=None, virtualnetworklist=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
-
delete_security_groups_to_vn_to_vlan_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes a security group ACL to virtual network.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_security_groups_to_vn_to_vlan
(filter=None, filter_type=None, page=None, size=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the security group ACL to virtual networks. Filter: [sgtId] To search guest users by using toDate column,follow the format: DD- MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 .
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_security_groups_to_vn_to_vlan
-
get_security_groups_to_vn_to_vlan_generator
(filter=None, filter_type=None, page=None, size=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the security group ACL to virtual networks. Filter: [sgtId] To search guest users by using toDate column,follow the format: DD- MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 .
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, headers=None, **query_parameters)[source]¶
-
create_security_groups_to_vn_to_vlan
(description=None, id=None, name=None, sgt_id=None, virtualnetworklist=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates a security group to virtual network.
- Parameters
description (string) – description, property of the request body.
id (string) – id, property of the request body.
name (string) – name, property of the request body.
sgt_id (string) – sgtId, property of the request body.
virtualnetworklist (list) – virtualnetworklist, property of the request body (list of objects).
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(description=None, id=None, name=None, sgt_id=None, virtualnetworklist=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_security_groups_to_vn_to_vlan
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the security group to virtual network.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
bulk_request_for_security_groups_to_vn_to_vlan
(operation_type=None, resource_media_type=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to submit the bulk request.
- Parameters
operation_type (string) – operationType, property of the request body.
resource_media_type (string) – resourceMediaType, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
bulk_request
(operation_type=None, resource_media_type=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
-
monitor_bulk_status_security_groups_to_vn_to_vlan
(bulkid, headers=None, **query_parameters)[source]¶ This API allows the client to monitor the bulk request.
- Parameters
bulkid (basestring) – bulkid path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
security_groups¶
-
class
SecurityGroups
[source]¶ Identity Services Engine SecurityGroups API (version: 3.1.0).
Wraps the Identity Services Engine SecurityGroups API and exposes the API as native Python methods that return native Python objects.
SGT API allows the client to search SGTs.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
Revision Modification
Revision Modification
Attribute
Description
0
1.0
1.2
Initial Cisco ISE Version
1
1.1
1.4
Cisco ISE 1.4 model changes
isTagFromRange
Removed Attribute isTagFromRange - depricated - set to FALSE value by default
2
1.2
2.3
Cisco ISE 2.3 model changes
propogateToApic
Added Boolean Attribute propogateToApic - By default value is false
3
1.3
2.7
Cisco ISE 2.7 model changes
isReadOnly
Added Boolean Attribute isReadOnly - By default value is false
defaultSGACLs
Added List Attribute defaultSGACLs
Resource Definition
Attribute
Type
Required
Description
Default Values
Example Values
name
String
Yes
Resource Name
Employees
id
String
No
Resource UUID, mandatory for update
93ad6890-8c01-11e6-996c-525400b48521
description
String
No
Employee Security Group
value
Integer
Yes
Value range: 2 ot 65519 or -1 to auto-generate
4
propogateToApic
Boolean
No
true
isReadOnly
Boolean
No
false
defaultSGACLs
List
No
[ ]
propogateToApic
Boolean
No
true
generationId
Integer
No
0
-
get_security_group_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get a security group by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_security_group_by_id
-
update_security_group_by_id
(id, default_sgacls=None, description=None, generation_id=None, is_read_only=None, name=None, propogate_to_apic=None, value=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update a security group.
- Parameters
default_sgacls (list) – defaultSGACLs, property of the request body (list of objects).
description (string) – description, property of the request body.
generation_id (string) – generationId, property of the request body.
id (basestring) – id, property of the request body.
is_read_only (boolean) – isReadOnly, property of the request body.
name (string) – name, property of the request body.
propogate_to_apic (boolean) – propogateToApic, property of the request body.
value (integer) – Value range: 2 ot 65519 or -1 to auto- generate, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, default_sgacls=None, description=None, generation_id=None, is_read_only=None, name=None, propogate_to_apic=None, value=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_security_group_by_id
-
delete_security_group_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes a security group.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_security_group_by_id
-
get_security_groups
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the security groups. Filter: [propogateToApic, name, description, value] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description, value].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_security_groups
-
get_security_groups_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the security groups. Filter: [propogateToApic, name, description, value] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description, value].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_security_groups_generator
-
create_security_group
(default_sgacls=None, description=None, generation_id=None, is_read_only=None, name=None, propogate_to_apic=None, value=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates a security group.
- Parameters
default_sgacls (list) – defaultSGACLs, property of the request body (list of objects).
description (string) – description, property of the request body.
generation_id (string) – generationId, property of the request body.
is_read_only (boolean) – isReadOnly, property of the request body.
name (string) – name, property of the request body.
propogate_to_apic (boolean) – propogateToApic, property of the request body.
value (integer) – Value range: 2 ot 65519 or -1 to auto- generate, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(default_sgacls=None, description=None, generation_id=None, is_read_only=None, name=None, propogate_to_apic=None, value=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_security_group
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the security groups.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
bulk_request_for_security_group
(operation_type=None, resource_media_type=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to submit the bulk request.
- Parameters
operation_type (string) – operationType, property of the request body.
resource_media_type (string) – resourceMediaType, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
bulk_request
(operation_type=None, resource_media_type=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for bulk_request_for_security_group
-
monitor_bulk_status_security_group
(bulkid, headers=None, **query_parameters)[source]¶ This API allows the client to monitor the bulk request.
- Parameters
bulkid (basestring) – bulkid path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
monitor_bulk_status
(bulkid, headers=None, **query_parameters)[source]¶ Alias for monitor_bulk_status_security_group
-
security_groups_acls¶
-
class
SecurityGroupsAcls
[source]¶ Identity Services Engine SecurityGroupsACLs API (version: 3.1.0).
Wraps the Identity Services Engine SecurityGroupsACLs API and exposes the API as native Python methods that return native Python objects.
Security Groups ACLs API allows the client to search security groups access control lists.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
Revision Modification
Revision Modification
Attribute
Description
0
1.0
2.0
Initial Cisco ISE Version
1
1.1
2.3
Introducing bulk operations
2
1.2
3.1
Cisco ISE 3.1 model changes
modelledContent
Adding modelled content from Cisco ISE 3.1
Resource Definition
Attribute
Type
Required
Description
Default Values
Example Values
name
String
Yes
Resource Name
Permit IP
id
String
No
Resource UUID, mandatory for update
92951ac0-8c01-11e6-996c-525400b48521
description
String
No
Permit IP SGACL
ACLContent
String
No
permit ip
ipVersion
Enum
Yes
Allowed values: IPV4, IPV6, IP_AGNOSTIC
IPV4
isReadOnly
Boolean
No
false
generationId
String
No
GenerationId is a read only attribute and is being generated by the server
0
modelledContent
List
No
Modelled content of contract
-
get_security_groups_acl_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get a security group ACL by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_security_groups_acl_by_id
-
update_security_groups_acl_by_id
(id, aclcontent=None, description=None, generation_id=None, ip_version=None, is_read_only=None, modelled_content=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update a security group ACL.
- Parameters
aclcontent (string) – aclcontent, property of the request body.
description (string) – description, property of the request body.
generation_id (string) – generationId, property of the request body.
id (basestring) – id, property of the request body.
ip_version (string) – Allowed values: IPV4, IPV6, IP_AGNOSTIC, property of the request body.
is_read_only (boolean) – isReadOnly, property of the request body.
modelled_content (object) – Modelled content of contract, property of the request body.
name (string) – name, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, aclcontent=None, description=None, generation_id=None, ip_version=None, is_read_only=None, modelled_content=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_security_groups_acl_by_id
-
delete_security_groups_acl_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes a security group ACL.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_security_groups_acl_by_id
-
get_security_groups_acl
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the security group ACLs. Filter: [ipVersion, name, description] To search guest users by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [ipVersion, name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_security_groups_acl
-
get_security_groups_acl_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the security group ACLs. Filter: [ipVersion, name, description] To search guest users by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [ipVersion, name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_security_groups_acl_generator
-
create_security_groups_acl
(aclcontent=None, description=None, generation_id=None, ip_version=None, is_read_only=None, modelled_content=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates a security group ACL.
- Parameters
aclcontent (string) – aclcontent, property of the request body.
description (string) – description, property of the request body.
generation_id (string) – generationId, property of the request body.
ip_version (string) – Allowed values: IPV4, IPV6, IP_AGNOSTIC, property of the request body.
is_read_only (boolean) – isReadOnly, property of the request body.
modelled_content (object) – Modelled content of contract, property of the request body.
name (string) – name, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(aclcontent=None, description=None, generation_id=None, ip_version=None, is_read_only=None, modelled_content=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_security_groups_acl
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the security group ACLs.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
bulk_request_for_security_groups_acl
(operation_type=None, resource_media_type=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to submit the bulk request.
- Parameters
operation_type (string) – operationType, property of the request body.
resource_media_type (string) – resourceMediaType, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
bulk_request
(operation_type=None, resource_media_type=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for bulk_request_for_security_groups_acl
-
monitor_bulk_status_security_groups_acl
(bulkid, headers=None, **query_parameters)[source]¶ This API allows the client to monitor the bulk request.
- Parameters
bulkid (basestring) – bulkid path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
monitor_bulk_status
(bulkid, headers=None, **query_parameters)[source]¶ Alias for monitor_bulk_status_security_groups_acl
-
self_registered_portal¶
-
class
SelfRegisteredPortal
[source]¶ Identity Services Engine SelfRegisteredPortal API (version: 3.1.0).
Wraps the Identity Services Engine SelfRegisteredPortal API and exposes the API as native Python methods that return native Python objects.
Self Registered Guest Portal API provides the ability to create, read, update, delete and search self registered portals.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.2
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Default Values
Example Values
name
String
Yes
Resource Name
Self-Registered Guest Portal (default)
id
String
No
Resource UUID, mandatory for update
4e8ade36-4048-472a-b345-632cc155acfc
description
String
No
Guests may create their own accounts and be assigned a username and password, or use their social login to access the network
portalTestUrl
String
No
URL to bring up a test page for this portal
https://{ise-ip}:8443/portal/PortalSetup.action?portal=4e8ade36-4048-472a-b345-632cc155acfc
portalType
Enum
Yes
Allowed values: BYOD, HOTSPOTGUEST, MYDEVICE, SELFREGGUEST, SPONSOR, SPONSOREDGUEST
SELFREGGUEST
settings
List
No
Defines all of the settings groups available for a portal
portalSettings
List
No
The port, interface, certificate, and other basic settings of a portal
httpsPort
Integer
Yes
The port number that the allowed interfaces will listen on. Range from 8000 to 8999
8443
allowedInterfaces
Enum
Yes
Interfaces that the portal will be reachable on.
[ “eth0”, “bond0” ]
certificateGroupTag
String
Yes
Logical name of the x.509 server certificate that will be used for the portal
Default Portal Certificate Group
authenticationMethod
String
Yes
Unique Id of the identity source sequence
92e50f80-8c01-11e6-996c-525400b48521
assignedGuestTypeForEmployee
String
Yes
Unique Id of a guest type. Employees using this portal as a guest inherit login options from the guest type
Contractor (default)
displayLang
Enum
No
Allowed values: USEBROWSERLOCALE, ALWAYSUSE
USEBROWSERLOCALE
fallbackLanguage
String
No
Used when displayLang = USEBROWSERLOCALE
English
alwaysUsedLanguage
String
No
Used when displayLang = ALWAYSUSE
English
loginPageSettings
List
No
Portal Login Page settings groups follow
maxFailedAttemptsBeforeRateLimit
Integer
No
Maximum failed login attempts before rate limiting
5
timeBetweenLoginsDuringRateLimit
Integer
No
Time between login attempts when rate limiting
2
includeAup
Boolean
No
Include an Acceptable Use Policy (AUP) that should be displayed during login
false
aupDisplay
Enum
No
How the AUP should be displayed, either on page or as a link. Only valid if includeAup = true.
ASLINK
requireAupAcceptance
Boolean
No
Require the portal user to accept the AUP. Only valid if includeAup = true
false
requireAccessCode
Boolean
No
Require the portal user to enter an access code
false
accessCode
String
No
Access code that must be entered by the portal user (only valid if requireAccessCode = true)
allowGuestToCreateAccounts
Boolean
No
false
allowGuestToChangePassword
Boolean
No
Require the portal user to enter an access code
false
allowAlternateGuestPortal
Boolean
No
false
alternateGuestPortal
String
No
selfRegPageSettings
List
No
assignGuestsToGuestType
String
No
Guests are assigned to this guest type
accountValidityDuration
Integer
No
Self-registered guest account is valid for this many account_validity_time_units
1
accountValidityTimeUnits
Enum
No
Time units for account_validity_duration.
DAYS
requireRegistrationCode
Boolean
No
Self-registered guests are required to enter a registration code
false
registrationCode
String
No
The registration code that the guest user must enter
fieldUserName
List
No
include
Boolean
No
true
require
Boolean
No
Only applicable if include = true
false
fieldFirstName
List
No
include
Boolean
No
true
require
Boolean
No
Only applicable if include = true
false
fieldLastName
List
No
include
Boolean
No
true
require
Boolean
No
Only applicable if include = true
false
fieldEmailAddr
List
No
include
Boolean
No
true
require
Boolean
No
Only applicable if include = true
false
fieldPhoneNo
List
No
include
Boolean
No
true
require
Boolean
No
Only applicable if include = true
false
fieldCompany
List
No
include
Boolean
No
true
require
Boolean
No
Only applicable if include = true
false
fieldLocation
List
No
include
Boolean
No
true
require
Boolean
No
Only applicable if include = true
false
selectableLocations
List
No
Guests can choose from these locations to set their time zone
[“San Jose”]
fieldSmsProvider
List
No
include
Boolean
No
true
require
Boolean
No
Only applicable if include = true
false
selectableSmsProviders
List
No
This attribute is an array of SMS provider names
[“Global Default”]
fieldPersonBeingVisited
List
No
include
Boolean
No
true
require
Boolean
No
Only applicable if include = true
false
fieldReasonForVisit
List
No
include
Boolean
No
true
require
Boolean
No
Only applicable if include = true
false
includeAup
Boolean
No
Include an Acceptable Use Policy (AUP) that should be displayed during login
false
aupDisplay
Enum
No
How the AUP should be displayed, either on page or as a link. Only valid if includeAup = true.
ASLINK
requireAupAcceptance
Boolean
No
Require the portal user to accept the AUP. Only valid if includeAup = true
false
enableGuestEmailWhitelist
Boolean
No
Allow guests with an e-mail address from selected domains
false
guestEmailWhitelistDomains
List
No
Self-registered guests whose e-mail address is in one of these domains will be allowed. Only valid if enableGuestEmailWhitelist = true
enableGuestEmailBlacklist
Boolean
No
Disallow guests with an e-mail address from selected domains
false
guestEmailBlacklistDomains
List
No
Self-registered guests whose e-mail address is in one of these domains will be disallowed. Only valid if enableGuestEmailBlacklist = true
requireGuestApproval
Boolean
No
Require self-registered guests to be approved if true
false
autoLoginSelfWait
Boolean
No
Allow guests to login automatically from self-registration after sponsor’s approval. No need to provide the credentials by guest to login
false
autoLoginTimePeriod
Integer
No
Waiting period for auto login until sponsor’s approval. If time exceeds, guest has to login manually by providing the credentials. Default value is 5 minutes
5
sendApprovalRequestTo
Enum
No
Specifies where approval requests are sent. Only valid if requireGuestApproval = true.
SELECTEDEMAILADDRESSES
approvalEmailAddresses
String
No
Only valid if requireGuestApproval = true and sendApprovalRequestTo = SELECTEDEMAILADDRESSES
postRegistrationRedirect
Enum
No
After the registration submission direct the guest user to one of the following pages. Only valid if requireGuestApproval = true.
SELFREGISTRATIONSUCCESS
postRegistrationRedirectUrl
String
No
URL where guest user is redirected after registration. Only valid if requireGuestApproval = true and postRegistrationRedirect = URL
credentialNotificationUsingEmail
Boolean
No
If true, send credential notification upon approval using email. Only valid if requireGuestApproval = true
false
credentialNotificationUsingSms
Boolean
No
If true, send credential notification upon approval using SMS. Only valid if requireGuestApproval = true
false
approveDenyLinksValidFor
Integer
No
This attribute, along with approveDenyLinksTimeUnits, specifies how long the link can be used. Only valid if requireGuestApproval = true
1440
approveDenyLinksTimeUnits
Enum
No
This attribute, along with approveDenyLinksValidFor, specifies how long the link can be used. Only valid if requireGuestApproval = true.
DAYS
requireApproverToAuthenticate
Boolean
No
When self-registered guests require approval, an approval request is e-mailed to one or more sponsor users. If the Cisco ISE Administrator chooses to include an approval link in the e-mail, a sponsor user who clicks the link will be required to enter their username and password if this attribute is true. Only valid if requireGuestApproval = true
false
sponsorPortalList
List
No
When self-registered guests require approval, an approval request is e-mailed to one or more sponsor users. If the Cisco ISE Administrator chooses to include an approval link in the e-mail, a sponsor user who clicks the link will be authenticated against the selected sponsor portals in the order specified. Only valid if requireGuestApproval = true. The array should contain the names of the selected portals
selfRegSuccessSettings
List
No
includeUserName
Boolean
No
true
includePassword
Boolean
No
true
includeFirstName
Boolean
No
true
includeLastName
Boolean
No
true
includeEmailAddr
Boolean
No
true
includePhoneNo
Boolean
No
true
includeCompany
Boolean
No
true
includeLocation
Boolean
No
true
includeSmsProvider
Boolean
No
true
includePersonBeingVisited
Boolean
No
true
includeReasonForVisit
Boolean
No
true
allowGuestSendSelfUsingPrint
Boolean
No
false
allowGuestSendSelfUsingEmail
Boolean
No
false
allowGuestSendSelfUsingSms
Boolean
No
false
includeAup
Boolean
No
false
aupOnPage
Boolean
No
false
requireAupAcceptance
Boolean
No
false
requireAupScrolling
Boolean
No
false
allowGuestLoginFromSelfregSuccessPage
Boolean
No
false
aupSettings
List
No
Configuration of the Acceptable Use Policy (AUP) for a portal
displayFrequency
Enum
No
How the AUP should be displayed, either on page or as a link. Only valid if includeAup = true.
FIRSTLOGIN
includeAup
Boolean
No
Require the portal user to read and accept an AUP
true
requireAupScrolling
Boolean
No
Require the portal user to scroll to the end of the AUP. Only valid if requireAupAcceptance = true
false
useDiffAupForEmployees
Boolean
No
Only valid if requireAupAcceptance = trueG
false
skipAupForEmployees
Boolean
No
Only valid if requireAupAcceptance = true
false
displayFrequencyIntervalDays
Integer
No
Number of days between AUP confirmations (when displayFrequency = recurring)
7
GuestChangePasswordSettings
List
No
allowChangePasswdAtFirstLogin
Boolean
No
Allow guest to change their own passwords
false
guestDeviceRegistrationSettings
List
No
autoRegisterGuestDevices
Boolean
No
Automatically register guest devices
true
allowGuestsToRegisterDevices
Boolean
No
Allow guests to register devices
false
byodSettings
List
No
Configuration of BYOD Device Welcome, Registration and Success steps
byodWelcomeSettings
List
No
Configuration of BYOD endpoint welcome step configuration
enableBYOD
Boolean
No
true
enableGuestAccess
Boolean
No
false
requireMDM
Boolean
No
false
includeAup
Boolean
No
true
aupDisplay
Enum
No
How the AUP should be displayed, either on page or as a link. Only valid if includeAup = true.
ONPAGE
requireAupAcceptance
Boolean
No
false
requireScrolling
Boolean
No
Require BYOD devices to scroll down to the bottom of the AUP, Only valid if includeAup = true
false
byodRegistrationSettings
List
No
Configuration of BYOD endpoint Registration step configuration
showDeviceID
Boolean
No
Display Device ID field during registration
true
endPointIdentityGroupId
String
No
Identity group id for which endpoint belongs
aa13bb40-8bff-11e6-996c-525400b48521
byodRegistrationSuccessSettings
List
No
Configuration of BYOD endpoint Registration Success step configuration
successRedirect
Enum
No
After an Authentication Success where should device be redirected.
AUTHSUCCESSPAGE
redirectUrl
String
No
Target URL for redirection, used when successRedirect = URL
authSuccessSettings
List
No
successRedirect
Enum
No
After an Authentication Success where should device be redirected.
AUTHSUCCESSPAGE
redirectUrl
String
No
Target URL for redirection, used when successRedirect = URL
www.cisco.com
postLoginBannerSettings
List
No
includePostAccessBanner
Boolean
No
Include a Post-Login Banner page
false
supportInfoSettings
List
No
Portal Support Information Settings
includeSupportInfoPage
Boolean
No
false
includeMacAddr
Boolean
No
false
includeIpAddress
Boolean
No
false
includeBrowserUserAgent
Boolean
No
false
includePolicyServer
Boolean
No
false
includeFailureCode
Boolean
No
false
emptyFieldDisplay
Enum
No
Specifies how empty fields are handled on the Support Information Page.
HIDE
defaultEmptyFieldValue
String
No
The default value displayed for an empty field Only valid when emptyFieldDisplay = DISPLAYWITHDEFAULTVALUE
customizations
List
No
Defines all of the Portal Customizations available
portalTheme
List
No
Defines the configuration for portal theme
id
String
No
The unique internal identifier of the portal theme
9eb421c0-8c01-11e6-996c-525400b48521
name
String
Yes
The system- or user-assigned name of the portal theme
Default Blue theme
themeData
String
No
A CSS file, represented as a Base64-encoded byte array
Base 64 encoded string of Theme CSS file
portalTweakSettings
List
No
The Tweak Settings are a customization of the Portal Theme that has been selected for the portal. When the Portal Theme selection is changed, the Tweak Settings are overwritten to match the values in the theme. The Tweak Settings can subsequently be changed by the user
bannerColor
String
No
Hex value of color
#0000FF
bannerTextColor
String
No
Banner Text color code from GUI
pageBackgroundColor
String
No
Color code from GUI
pageLabelAndTextColor
String
No
Label and Text color from GUI
language
List
No
This property is supported only for Read operation and it allows to show the customizations in English. Other languages are not supported
viewLanguage
String
No
English
globalCustomizations
List
No
Represent the portal Global customizations
bannerTitle
String
No
Guest Portal
contactText
String
No
Contact Support
footerElement
String
No
Footer Element
mobileLogoImage
Image
No
data
String
No
Represented as base 64 encoded string of the image byte array
base 64 encoded value of image
desktopLogoImage
Image
No
data
String
No
Represented as base 64 encoded string of the image byte array
base 64 encoded value of image
bannerImage
Image
No
data
String
No
Represented as base 64 encoded string of the image byte array
base 64 encoded value of image
backgroundImage
Image
No
data
String
No
Represented as base 64 encoded string of the image byte array
base 64 encoded value of image
pageCustomizations
List
No
Represent the entire page customization as a giant dictionary
data
List
No
The Dictionary will be exposed here as key value pair
key
String
Yes
ui_contact_ip_address_label
value
String
Yes
SVAgYWRkcmVzczo=
-
get_self_registered_portal_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get a self registered portal by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_self_registered_portal_by_id
-
update_self_registered_portal_by_id
(id, customizations=None, description=None, name=None, portal_test_url=None, portal_type=None, settings=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update a self registered portal by ID.
- Parameters
customizations (object) – Defines all of the Portal Customizations available, property of the request body.
description (string) – description, property of the request body.
id (basestring) – id, property of the request body.
name (string) – name, property of the request body.
portal_test_url (string) – URL to bring up a test page for this portal, property of the request body.
portal_type (string) – Allowed values: BYOD, HOTSPOTGUEST, MYDEVICE, SELFREGGUEST, SPONSOR, SPONSOREDGUEST, property of the request body.
settings (object) – Defines all of the settings groups available for a portal, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, customizations=None, description=None, name=None, portal_test_url=None, portal_type=None, settings=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_self_registered_portal_by_id
-
delete_self_registered_portal_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes a self registered portal by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_self_registered_portal_by_id
-
get_self_registered_portals
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the self registered portals. Filter: [name] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_self_registered_portals
-
get_self_registered_portals_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the self registered portals. Filter: [name] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_self_registered_portals_generator
-
create_self_registered_portal
(customizations=None, description=None, name=None, portal_test_url=None, portal_type=None, settings=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates a self registered portal.
- Parameters
customizations (object) – Defines all of the Portal Customizations available, property of the request body.
description (string) – description, property of the request body.
name (string) – name, property of the request body.
portal_test_url (string) – URL to bring up a test page for this portal, property of the request body.
portal_type (string) – Allowed values: BYOD, HOTSPOTGUEST, MYDEVICE, SELFREGGUEST, SPONSOR, SPONSOREDGUEST, property of the request body.
settings (object) – Defines all of the settings groups available for a portal, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(customizations=None, description=None, name=None, portal_test_url=None, portal_type=None, settings=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_self_registered_portal
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the self registered portal.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
session_directory¶
-
class
SessionDirectory
[source]¶ Identity Services Engine Session Directory API (version: 3.1.0).
Wraps the Identity Services Engine Session Directory API and exposes the API as native Python methods that return native Python objects.
# Cisco ISE 3.0 pxGrid REST APIs
## License [Cisco Sample Code License](https://developer.cisco.com/site/license/cisco-sample-code-license/)
## Status These are the status icons for the requests so far. - ⌗ : must create resources to test - 🚧 : incomplete | untested - 🛑 : unsupported | bug
## Environment Variables This collection uses environment variables in scripts in the Tests tab to store data (id, name, portalId, etc.) between requests. This allows you to GET or POST then immediately GET {id} on a resource. Using No Environment will cause this convenience functionality to fail so be sure to choose one.
## Collection Variables This collection includes some default variables that you will want to update or override with environment variables for your ISE deployment. Specifically, you will want to set: - ise_pxg: the ISE PAN node name or IP address. Default: ise.securitydemo.net - rest_username: the username for ERS API access. Must be a member of SuperAdmin, ERSAdmin or ERSOperator groups. Default: admin which is the ISE SuperAdmin - rest_password: Default: C1sco12345
-
get_sessions
(headers=None, **query_parameters)[source]¶ 🚧 getSessions.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_sessions_for_recovery
(headers=None, **query_parameters)[source]¶ 🚧 getSessionsForRecovery.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_session_by_ip_address
(headers=None, **query_parameters)[source]¶ 🚧 getSessionByIpAddress.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_session_by_mac_address
(headers=None, **query_parameters)[source]¶ 🚧 getSessionByMacAddress.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_user_groups
(headers=None, **query_parameters)[source]¶ 🚧 getUserGroups.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_user_group_by_user_name
(headers=None, **query_parameters)[source]¶ 🚧 getUserGroupByUserName.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_name
(headers=None, **query_parameters)[source]¶ Alias for get_user_group_by_user_name
-
sponsor_group¶
-
class
SponsorGroup
[source]¶ Identity Services Engine SponsorGroup API (version: 3.1.0).
Wraps the Identity Services Engine SponsorGroup API and exposes the API as native Python methods that return native Python objects.
Sponsor Group API allows the client to add, delete, update and search sponsor groups.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.2
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Default Values
Example Values
name
String
Yes
Resource Name
EmplALL_ACCOUNTS (default)oyees
id
String
No
Resource UUID, mandatory for update
9f1eca71-8c01-11e6-996c-525400b48521
description
String
No
Sponsors assigned to this group can manage all guest user accounts. By default, users in the ALL_ACCOUNTS user identity group are members of this sponsor group
isEnabled
Boolean
No
true
isDefaultGroup
Boolean
No
true
memberGroups
List
No
[“ALL_ACCOUNTS (default)”]
guestTypes
List
No
[“Contractor (default)”, “Daily (default)”, “Weekly (default)” ]
locations
List
No
[“San Jose”]
autoNotification
Boolean
No
false
managePermission
Enum
No
Allowed values:
ALLACCOUNTS, GROUPACCOUNTS, OWNACCOUNTS
createPermissions
List
No
canImportMultipleAccounts
Boolean
No
true
importBatchSizeLimit
Integer
No
200
canCreateRandomAccounts
Boolean
No
true
randomBatchSizeLimit
Integer
No
200
defaultUsernamePrefix
String
No
canSpecifyUsernamePrefix
Boolean
No
true
canSetFutureStartDate
Boolean
No
false
startDateFutureLimitDays
Integer
No
1
otherPermissions
List
No
canUpdateGuestContactInfo
Boolean
No
true
canViewGuestPasswords
Boolean
No
true
canSendSmsNotifications
Boolean
No
false
canResetGuestPasswords
Boolean
No
true
canExtendGuestAccounts
Boolean
No
true
canDeleteGuestAccounts
Boolean
No
true
canSuspendGuestAccounts
Boolean
Yes
true
requireSuspensionReason
Boolean
No
false
canReinstateSuspendedAccounts
Boolean
No
true
canApproveSelfregGuests
Boolean
No
true
limitApprovalToSponsorsGuests
Boolean
Yes
false
canAccessViaRest
Boolean
No
false
-
get_sponsor_group_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get a sponsor group by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_sponsor_group_by_id
-
update_sponsor_group_by_id
(id, auto_notification=None, create_permissions=None, description=None, guest_types=None, is_default_group=None, is_enabled=None, locations=None, manage_permission=None, member_groups=None, name=None, other_permissions=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update a sponsor group by ID.
- Parameters
auto_notification (boolean) – autoNotification, property of the request body.
create_permissions (object) – createPermissions, property of the request body.
description (string) – description, property of the request body.
guest_types (list) – guestTypes, property of the request body (list of strings).
id (basestring) – id, property of the request body.
is_default_group (boolean) – isDefaultGroup, property of the request body.
is_enabled (boolean) – isEnabled, property of the request body.
locations (list) – locations, property of the request body (list of strings).
manage_permission (string) – managePermission, property of the request body.
member_groups (list) – memberGroups, property of the request body (list of strings).
name (string) – name, property of the request body.
other_permissions (object) – otherPermissions, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, auto_notification=None, create_permissions=None, description=None, guest_types=None, is_default_group=None, is_enabled=None, locations=None, manage_permission=None, member_groups=None, name=None, other_permissions=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_sponsor_group_by_id
-
delete_sponsor_group_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes a sponsor group by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_sponsor_group_by_id
-
get_sponsor_group
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the sponsor groups. Filter: [name] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_sponsor_group
-
get_sponsor_group_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the sponsor groups. Filter: [name] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_sponsor_group_generator
-
create_sponsor_group
(auto_notification=None, create_permissions=None, description=None, guest_types=None, is_default_group=None, is_enabled=None, locations=None, manage_permission=None, member_groups=None, name=None, other_permissions=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates a sponsor group.
- Parameters
auto_notification (boolean) – autoNotification, property of the request body.
create_permissions (object) – createPermissions, property of the request body.
description (string) – description, property of the request body.
guest_types (list) – guestTypes, property of the request body (list of strings).
is_default_group (boolean) – isDefaultGroup, property of the request body.
is_enabled (boolean) – isEnabled, property of the request body.
locations (list) – locations, property of the request body (list of strings).
manage_permission (string) – managePermission, property of the request body.
member_groups (list) – memberGroups, property of the request body (list of strings).
name (string) – name, property of the request body.
other_permissions (object) – otherPermissions, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(auto_notification=None, create_permissions=None, description=None, guest_types=None, is_default_group=None, is_enabled=None, locations=None, manage_permission=None, member_groups=None, name=None, other_permissions=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_sponsor_group
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the sponsor group.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
sponsor_group_member¶
-
class
SponsorGroupMember
[source]¶ Identity Services Engine SponsorGroupMember API (version: 3.1.0).
Wraps the Identity Services Engine SponsorGroupMember API and exposes the API as native Python methods that return native Python objects.
Sponsor Group API allows the client to search the group members from different identity stores configured in the GUI.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.2
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Example Values
name
String
Yes
Resource Name
ALL_ACCOUNTS (default)
id
String
No
Resource UUID value
a176c430-8c01-11e6-996c-525400b48521
description
String
No
dicType
String
Yes
guid
String
Yes
-
get_sponsor_group_member
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the sponsor group members. Filter: [name] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_sponsor_group_member
-
get_sponsor_group_member_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the sponsor group members. Filter: [name] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_sponsor_group_member_generator
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the sponsor group member.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
sponsor_portal¶
-
class
SponsorPortal
[source]¶ Identity Services Engine SponsorPortal API (version: 3.1.0).
Wraps the Identity Services Engine SponsorPortal API and exposes the API as native Python methods that return native Python objects.
Sponsor Portal API provides the ability to create, read, update, delete and search sponsor portals.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.2
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Default Values
Example Values
name
String
Yes
Resource Name
Sponsor Portal (default)
id
String
No
Resource UUID, mandatory for update
04cd708b-feef-4c75-bf3e-2d2a9c302da2
description
String
No
Default portal used by sponsors to create and manage accounts for authorized visitors to securely access the network
portalTestUrl
String
No
URL to bring up a test page for this portal
https://{ise-ip}:8445/portal/PortalSetup.action?portal=04cd708b-feef-4c75-bf3e-2d2a9c302da2
portalType
Enum
Yes
Allowed values: BYOD, HOTSPOTGUEST, MYDEVICE, SELFREGGUEST, SPONSOR, SPONSOREDGUEST
SPONSOR
settings
List
No
Defines all of the settings groups available for a portal
portalSettings
List
No
The port, interface, certificate, and other basic settings of a portal
httpsPort
Integer
Yes
The port number that the allowed interfaces will listen on. Range from 8000 to 8999
8445
allowedInterfaces
Enum
Yes
Interfaces that the portal will be reachable on.
[ “eth0”, “bond0” ]
certificateGroupTag
String
Yes
Logical name of the x.509 server certificate that will be used for the portal
Default Portal Certificate Group
fqdn
String
No
The fully-qualified domain name (FQDN) that end-users will use to access this portal. Used only in Sponsor portal
Default Portal Certificate Group
authenticationMethod
String
Yes
Unique Id of the identity source sequence
92faba60-8c01-11e6-996c-525400b48521
idleTimeout
Integer
No
10
displayLang
Enum
No
Allowed values: USEBROWSERLOCALE, ALWAYSUSE
USEBROWSERLOCALE
fallbackLanguage
String
No
Used when displayLang = USEBROWSERLOCALE
English
alwaysUsedLanguage
String
No
Used when displayLang = ALWAYSUSE
English
availableSsids
List
No
Names of the SSIDs available for assignment to guest users by sponsors
loginPageSettings
List
No
Portal Login Page settings groups follow
maxFailedAttemptsBeforeRateLimit
Integer
No
Maximum failed login attempts before rate limiting
5
timeBetweenLoginsDuringRateLimit
Integer
No
Time between login attempts when rate limiting
2
includeAup
Boolean
No
Include an Acceptable Use Policy (AUP) that should be displayed during login
false
aupDisplay
Enum
No
How the AUP should be displayed, either on page or as a link. Only valid if includeAup = true.
ASLINK
requireAupAcceptance
Boolean
No
Require the portal user to accept the AUP. Only valid if includeAup = true
false
aupSettings
List
No
Configuration of the Acceptable Use Policy (AUP) for a portal
displayFrequency
Enum
No
How the AUP should be displayed, either on page or as a link. Only valid if includeAup = true.
FIRSTLOGIN
includeAup
Boolean
No
Require the portal user to read and accept an AUP
true
requireAupScrolling
Boolean
No
Require the portal user to scroll to the end of the AUP. Only valid if requireAupAcceptance = true
false
displayFrequencyIntervalDays
Integer
No
Number of days between AUP confirmations (when displayFrequency = recurring)
7
sponsorChangePasswordSettings
List
No
allowSponsorToChangePwd
Boolean
No
Allow sponsors to change their own passwords
false
postLoginBannerSettings
List
No
includePostAccessBanner
Boolean
No
Include a Post-Login Banner page
false
supportInfoSettings
List
No
Portal Support Information Settings
includeSupportInfoPage
Boolean
No
false
includeMacAddr
Boolean
No
false
includeIpAddress
Boolean
No
false
includeBrowserUserAgent
Boolean
No
false
includePolicyServer
Boolean
No
false
includeFailureCode
Boolean
No
false
emptyFieldDisplay
Enum
No
Specifies how empty fields are handled on the Support Information Page.
HIDE
defaultEmptyFieldValue
String
No
The default value displayed for an empty field Only valid when emptyFieldDisplay = DISPLAYWITHDEFAULTVALUE
customizations
List
No
Defines all of the Portal Customizations available
portalTheme
List
No
Defines the configuration for portal theme
id
String
No
The unique internal identifier of the portal theme
9eb421c0-8c01-11e6-996c-525400b48521
name
String
Yes
The system- or user-assigned name of the portal theme
Default Blue theme
themeData
String
No
A CSS file, represented as a Base64-encoded byte array
Base 64 encoded string of Theme CSS file
portalTweakSettings
List
No
The Tweak Settings are a customization of the Portal Theme that has been selected for the portal. When the Portal Theme selection is changed, the Tweak Settings are overwritten to match the values in the theme. The Tweak Settings can subsequently be changed by the user
bannerColor
String
No
Hex value of color
#0000FF
bannerTextColor
String
No
Banner Text color code from GUI
pageBackgroundColor
String
No
Color code from GUI
pageLabelAndTextColor
String
No
Label and Text color from GUI
language
List
No
This property is supported only for Read operation and it allows to show the customizations in English. Other languages are not supported
viewLanguage
String
No
English
globalCustomizations
List
No
Represent the portal Global customizations
bannerTitle
String
No
Guest Portal
contactText
String
No
Contact Support
footerElement
String
No
Footer Element
mobileLogoImage
Image
No
data
String
No
Represented as base 64 encoded string of the image byte array
base 64 encoded value of image
desktopLogoImage
Image
No
data
String
No
Represented as base 64 encoded string of the image byte array
base 64 encoded value of image
bannerImage
Image
No
data
String
No
Represented as base 64 encoded string of the image byte array
base 64 encoded value of image
backgroundImage
Image
No
data
String
No
Represented as base 64 encoded string of the image byte array
base 64 encoded value of image
pageCustomizations
List
No
Represent the entire page customization as a giant dictionary
data
List
No
The Dictionary will be exposed here as key value pair
key
String
Yes
ui_contact_ip_address_label
value
String
Yes
SVAgYWRkcmVzczo=
-
get_sponsor_portal_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get a sponsor portal by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_sponsor_portal_by_id
-
update_sponsor_portal_by_id
(id, customizations=None, description=None, name=None, portal_test_url=None, portal_type=None, settings=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update a sponsor portal by ID.
- Parameters
customizations (object) – customizations, property of the request body.
description (string) – description, property of the request body.
id (basestring) – id, property of the request body.
name (string) – name, property of the request body.
portal_test_url (string) – URL to bring up a test page for this portal, property of the request body.
portal_type (string) – Allowed values: BYOD, HOTSPOTGUEST, MYDEVICE, SELFREGGUEST, SPONSOR, SPONSOREDGUEST, property of the request body.
settings (object) – Defines all of the settings groups available for a portal, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, customizations=None, description=None, name=None, portal_test_url=None, portal_type=None, settings=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_sponsor_portal_by_id
-
delete_sponsor_portal_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes a sponsor portal by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_sponsor_portal_by_id
-
get_sponsor_portal
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the sponsor portals. Filter: [name, description] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_sponsor_portal
-
get_sponsor_portal_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the sponsor portals. Filter: [name, description] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_sponsor_portal_generator
-
create_sponsor_portal
(customizations=None, description=None, name=None, portal_test_url=None, portal_type=None, settings=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates a sponsor portal.
- Parameters
customizations (object) – customizations, property of the request body.
description (string) – description, property of the request body.
name (string) – name, property of the request body.
portal_test_url (string) – URL to bring up a test page for this portal, property of the request body.
portal_type (string) – Allowed values: BYOD, HOTSPOTGUEST, MYDEVICE, SELFREGGUEST, SPONSOR, SPONSOREDGUEST, property of the request body.
settings (object) – Defines all of the settings groups available for a portal, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(customizations=None, description=None, name=None, portal_test_url=None, portal_type=None, settings=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_sponsor_portal
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the sponsor portal.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
sponsored_guest_portal¶
-
class
SponsoredGuestPortal
[source]¶ Identity Services Engine SponsoredGuestPortal API (version: 3.1.0).
Wraps the Identity Services Engine SponsoredGuestPortal API and exposes the API as native Python methods that return native Python objects.
Sponsored Guest Portal API provides the ability to create, read, update, delete and search sponsored guest portals.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.2
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Default Values
Example Values
name
String
Yes
Resource Name
Sponsored Guest Portal (default))
id
String
No
Resource UUID, mandatory for update
d135de9f-cd87-4ce7-b1a4-1d9c7cf35f33
description
String
No
Sponsors create guest accounts, and guests access the network using their assigned username and password
portalTestUrl
String
No
URL to bring up a test page for this portal
https://{ise-ip}:8443/portal/PortalSetup.action?portal=d135de9f-cd87-4ce7-b1a4-1d9c7cf35f33
portalType
Enum
Yes
Allowed values: BYOD, HOTSPOTGUEST, MYDEVICE, SELFREGGUEST, SPONSOR, SPONSOREDGUEST
SPONSOREDGUEST
settings
List
No
Defines all of the settings groups available for a portal
portalSettings
List
No
The port, interface, certificate, and other basic settings of a portal
httpsPort
Integer
Yes
The port number that the allowed interfaces will listen on. Range from 8000 to 8999
8443
allowedInterfaces
Enum
Yes
Interfaces that the portal will be reachable on. Allowed values: eth0, eth1, eth2, eth3, eth4, eth5, bond0, bond1, bond2
[ “eth0”, “bond0” ]
certificateGroupTag
String
Yes
Logical name of the x.509 server certificate that will be used for the portal
Default Portal Certificate Group
authenticationMethod
String
Yes
Unique Id of the identity source sequence
92faba60-8c01-11e6-996c-525400b48521
assignedGuestTypeForEmployee
String
Yes
Unique Id of a guest type. Employees using this portal as a guest inherit login options from the guest type
Contractor (default)
displayLang
Enum
No
Allowed values: USEBROWSERLOCALE, ALWAYSUSE
USEBROWSERLOCALE
fallbackLanguage
String
No
Used when displayLang = USEBROWSERLOCALE
English
alwaysUsedLanguage
String
No
Used when displayLang = ALWAYSUSE
English
loginPageSettings
List
No
Portal Login Page settings groups follow
maxFailedAttemptsBeforeRateLimit
Integer
No
Maximum failed login attempts before rate limiting
5
timeBetweenLoginsDuringRateLimit
Integer
No
Time between login attempts when rate limiting
2
includeAup
Boolean
No
Include an Acceptable Use Policy (AUP) that should be displayed during login
false
aupDisplay
Enum
No
How the AUP should be displayed, either on page or as a link. Only valid if includeAup = true. Allowed values: ONPAGE, ASLINK
ASLINK
requireAupAcceptance
Boolean
No
Require the portal user to accept the AUP. Only valid if includeAup = true
false
requireAccessCode
Boolean
No
Require the portal user to enter an access code
false
accessCode
String
No
Access code that must be entered by the portal user (only valid if requireAccessCode = true)
allowGuestToCreateAccounts
Boolean
No
false
allowGuestToChangePassword
Boolean
No
Require the portal user to enter an access code
false
aupSettings
List
No
Configuration of the Acceptable Use Policy (AUP) for a portal
displayFrequency
Enum
No
How the AUP should be displayed, either on page or as a link. Only valid if includeAup = true. Allowed Values: FIRSTLOGIN, EVERYLOGIN, RECURRING
FIRSTLOGIN
includeAup
Boolean
No
Require the portal user to read and accept an AUP
true
requireAupScrolling
Boolean
No
Require the portal user to scroll to the end of the AUP. Only valid if requireAupAcceptance = true
false
useDiffAupForEmployees
Boolean
No
Only valid if requireAupAcceptance = trueG
false
skipAupForEmployees
Boolean
No
Only valid if requireAupAcceptance = true
false
displayFrequencyIntervalDays
Integer
No
Number of days between AUP confirmations (when displayFrequency = recurring)
7
GuestChangePasswordSettings
List
No
allowChangePasswdAtFirstLogin
Boolean
No
Allow guest to change their own passwords
false
guestDeviceRegistrationSettings
List
No
autoRegisterGuestDevices
Boolean
No
Automatically register guest devices
true
allowGuestsToRegisterDevices
Boolean
No
Allow guests to register devices
false
byodSettings
List
No
Configuration of BYOD Device Welcome, Registration and Success steps
byodWelcomeSettings
List
No
Configuration of BYOD endpoint welcome step configuration
enableBYOD
Boolean
No
true
enableGuestAccess
Boolean
No
false
requireMDM
Boolean
No
false
includeAup
Boolean
No
true
aupDisplay
Enum
No
How the AUP should be displayed, either on page or as a link. Only valid if includeAup = true. Allowed values: ONPAGE, ASLINK
ONPAGE
requireAupAcceptance
Boolean
No
false
requireScrolling
Boolean
No
Require BYOD devices to scroll down to the bottom of the AUP, Only valid if includeAup = true
false
byodRegistrationSettings
List
No
Configuration of BYOD endpoint Registration step configuration
showDeviceID
Boolean
No
Display Device ID field during registration
true
endPointIdentityGroupId
String
No
Identity group id for which endpoint belongs
aa13bb40-8bff-11e6-996c-525400b48521
byodRegistrationSuccessSettings
List
No
Configuration of BYOD endpoint Registration Success step configuration
successRedirect
Enum
No
After an Authentication Success where should device be redirected. Allowed values: AUTHSUCCESSPAGE, ORIGINATINGURL, URL
AUTHSUCCESSPAGE
redirectUrl
String
No
Target URL for redirection, used when successRedirect = URL
authSuccessSettings
List
No
successRedirect
Enum
No
After an Authentication Success where should device be redirected. Allowed values: AUTHSUCCESSPAGE, ORIGINATINGURL, URL
AUTHSUCCESSPAGE
redirectUrl
String
No
Target URL for redirection, used when successRedirect = URL
www.cisco.com
postLoginBannerSettings
List
No
includePostAccessBanner
Boolean
No
Include a Post-Login Banner page
false
supportInfoSettings
List
No
Portal Support Information Settings
includeSupportInfoPage
Boolean
No
false
includeMacAddr
Boolean
No
false
includeIpAddress
Boolean
No
false
includeBrowserUserAgent
Boolean
No
false
includePolicyServer
Boolean
No
false
includeFailureCode
Boolean
No
false
emptyFieldDisplay
Enum
No
Specifies how empty fields are handled on the Support Information Page. Allowed values: HIDE, DISPLAYWITHNOVALUE, DISPLAYWITHDEFAULTVALUE
HIDE
defaultEmptyFieldValue
String
No
The default value displayed for an empty field Only valid when emptyFieldDisplay = DISPLAYWITHDEFAULTVALUE
customizations
List
No
Defines all of the Portal Customizations available
portalTheme
List
No
Defines the configuration for portal theme
id
String
No
The unique internal identifier of the portal theme
9eb421c0-8c01-11e6-996c-525400b48521
name
String
Yes
The system- or user-assigned name of the portal theme
Default Blue theme
themeData
String
No
A CSS file, represented as a Base64-encoded byte array
Base 64 encoded string of Theme CSS file
portalTweakSettings
List
No
The Tweak Settings are a customization of the Portal Theme that has been selected for the portal. When the Portal Theme selection is changed, the Tweak Settings are overwritten to match the values in the theme. The Tweak Settings can subsequently be changed by the user
bannerColor
String
No
Hex value of color
#0000FF
bannerTextColor
String
No
Banner Text color code from GUI
pageBackgroundColor
String
No
Color code from GUI
pageLabelAndTextColor
String
No
Label and Text color from GUI
language
List
No
This property is supported only for Read operation and it allows to show the customizations in English. Other languages are not supported
viewLanguage
String
No
English
globalCustomizations
List
No
Represent the portal Global customizations
bannerTitle
String
No
Guest Portal
contactText
String
No
Contact Support
footerElement
String
No
Footer Element
mobileLogoImage
Image
No
data
String
No
Represented as base 64 encoded string of the image byte array
base 64 encoded value of image
desktopLogoImage
Image
No
data
String
No
Represented as base 64 encoded string of the image byte array
base 64 encoded value of image
bannerImage
Image
No
data
String
No
Represented as base 64 encoded string of the image byte array
base 64 encoded value of image
backgroundImage
Image
No
data
String
No
Represented as base 64 encoded string of the image byte array
base 64 encoded value of image
pageCustomizations
List
No
Represent the entire page customization as a giant dictionary
data
List
No
The Dictionary will be exposed here as key value pair
key
String
Yes
ui_contact_ip_address_label
value
String
Yes
SVAgYWRkcmVzczo=
-
get_sponsored_guest_portal_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get a sponsored guest portal by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_sponsored_guest_portal_by_id
-
update_sponsored_guest_portal_by_id
(id, customizations=None, description=None, name=None, portal_test_url=None, portal_type=None, settings=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update a sponsored guest portal by ID.
- Parameters
customizations (object) – Defines all of the Portal Customizations available, property of the request body.
description (string) – description, property of the request body.
id (basestring) – id, property of the request body.
name (string) – name, property of the request body.
portal_test_url (string) – URL to bring up a test page for this portal, property of the request body.
portal_type (string) – Allowed values: BYOD, HOTSPOTGUEST, MYDEVICE, SELFREGGUEST, SPONSOR, SPONSOREDGUEST, property of the request body.
settings (object) – Defines all of the settings groups available for a portal, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, customizations=None, description=None, name=None, portal_test_url=None, portal_type=None, settings=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_sponsored_guest_portal_by_id
-
delete_sponsored_guest_portal_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes a sponsored guest portal by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_sponsored_guest_portal_by_id
-
get_sponsored_guest_portals
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the sponsored guest portals. Filter: [name, description] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_sponsored_guest_portals
-
get_sponsored_guest_portals_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the sponsored guest portals. Filter: [name, description] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_sponsored_guest_portals_generator
-
create_sponsored_guest_portal
(customizations=None, description=None, name=None, portal_test_url=None, portal_type=None, settings=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates a sponsored guest portal.
- Parameters
customizations (object) – Defines all of the Portal Customizations available, property of the request body.
description (string) – description, property of the request body.
name (string) – name, property of the request body.
portal_test_url (string) – URL to bring up a test page for this portal, property of the request body.
portal_type (string) – Allowed values: BYOD, HOTSPOTGUEST, MYDEVICE, SELFREGGUEST, SPONSOR, SPONSOREDGUEST, property of the request body.
settings (object) – Defines all of the settings groups available for a portal, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(customizations=None, description=None, name=None, portal_test_url=None, portal_type=None, settings=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_sponsored_guest_portal
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the sponsored guest portal.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
support_bundle_download¶
-
class
SupportBundleDownload
[source]¶ Identity Services Engine SupportBundleDownload API (version: 3.1.0).
Wraps the Identity Services Engine SupportBundleDownload API and exposes the API as native Python methods that return native Python objects.
Support Bundle Download API allows client to download support bundles provided those are generated and available in the default location.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.7
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Example Values
name
String
Yes
Resource Name
id
String
No
Resource UUID, mandatory for update
description
String
No
fileName
String
Yes
File name along with path from where file needs to be downloaded
filename
-
download_support_bundle
(file_name=None, dirpath=None, save_file=None, filename=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to upload a support bundle.
- Parameters
file_name (string) – fileName, property of the request body.
dirpath (basestring) – Directory absolute path. Defaults to os.getcwd().
save_file (bool) – Enable or disable automatic file creation of raw response.
filename (basestring) – The filename used to save the download file.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
The DownloadResponse wrapper. Wraps the urllib3.response.HTTPResponse. For more information check the urlib3 documentation
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
DownloadFailure – If was not able to download the raw
response to a file. –
-
download
(file_name=None, dirpath=None, save_file=None, filename=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for download_support_bundle
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the support bundle download.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
support_bundle_status¶
-
class
SupportBundleStatus
[source]¶ Identity Services Engine SupportBundleStatus API (version: 3.1.0).
Wraps the Identity Services Engine SupportBundleStatus API and exposes the API as native Python methods that return native Python objects.
Support Bundle Status API allows clients to query status of a triggered support bundle.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.7
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Example Values
name
String
Yes
Resource Name
ciscoise
id
String
No
Resource UUID, mandatory for update
ciscoise
description
String
No
Support Bundle Status api
fileName
String
No
ise-support-bundle-pk-ciscoise-admin-04-09-2021-15-07.tar.gpg
fileSize
Integer
No
1080924274
hostName
String
No
ciscoise
message
String
No
Support Bundle generation completed
startTime
String
No
Fri Apr 09 15:07:55 IST 2021
status
String
No
complete
-
get_support_bundle_status_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get a support bundle status by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_support_bundle_status_by_id
-
get_support_bundle_status
(page=None, size=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the support bundle status.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_support_bundle_status
-
get_support_bundle_status_generator
(page=None, size=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the support bundle status.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_support_bundle_status_generator
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the support bundle status.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
support_bundle_trigger_configuration¶
-
class
SupportBundleTriggerConfiguration
[source]¶ Identity Services Engine SupportBundleTriggerConfiguration API (version: 3.1.0).
Wraps the Identity Services Engine SupportBundleTriggerConfiguration API and exposes the API as native Python methods that return native Python objects.
Support Bundle Trigger API allows clients to trigger support bundle provided the log settings are given using which the support needs to be generated.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.7
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Default Values
name
String
Yes
Resource Name
supportBundle
id
String
No
Resource UUID, mandatory for update
1af3d6e2-cc3b-4603-b80f-6827768335ab
description
String
No
Support Bundle Generation
hostName
String
Yes
This parameter is hostName only, xxxx of xxxx.yyy.zz
sampleHost
supportBundleOptions
List
Yes
includeConfigDB
Boolean
Yes
Set to include Config DB in Support Bundle
false
includeDebugLogs
Boolean
Yes
Set to include Debug logs in Support Bundle
false
includeLocalLogs
Boolean
Yes
Set to include Local logs in Support Bundle
false
includeCoreFiles
Boolean
Yes
Set to include Core files in Support Bundle
false
includeSystemLogs
Boolean
Yes
Set to include System logs in Support Bundle
false
mntLogs
Boolean
Yes
Set to include Monitoring and troublshooting logs in Support Bundle
false
policyXml
Boolean
Yes
Set to include Policy XML in Support Bundle
false
fromDate
Date
No
Date from where support bundle should include the logs
04/21/2019
toDate
Date
No
Date upto where support bundle should include the logs
04/22/2019
-
create_support_bundle
(description=None, host_name=None, name=None, support_bundle_include_options=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to create a support bundle trigger configuration.
- Parameters
description (string) – description, property of the request body.
host_name (string) – This parameter is hostName only, xxxx of xxxx.yyy.zz, property of the request body.
name (string) – Resource Name, property of the request body.
support_bundle_include_options (object) – supportBundleIncludeOptions, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(description=None, host_name=None, name=None, support_bundle_include_options=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_support_bundle
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the support bundle trigger configuration.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
sync_ise_node¶
-
class
SyncIseNode
[source]¶ Identity Services Engine Sync ISE Node API (version: 3.1.0).
Wraps the Identity Services Engine Sync ISE Node API and exposes the API as native Python methods that return native Python objects.
APIs for the configuration, administration and monitoring of the nodes in an ISE cluster deployment.
-
sync_node
(hostname=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Performing a manual sync will involve a reload of the target node, but not the primary PAN. There might be situations where if the node has been out of sync for a long time, it may not be possible to recover via a manual sync.
- Parameters
hostname (string) – hostname, property of the request body. Constraints: maxLength set to 64 and minLength set to 1.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
system_health¶
-
class
SystemHealth
[source]¶ Identity Services Engine System Health API (version: 3.1.0).
Wraps the Identity Services Engine System Health API and exposes the API as native Python methods that return native Python objects.
# Cisco ISE 3.0 pxGrid REST APIs
## License [Cisco Sample Code License](https://developer.cisco.com/site/license/cisco-sample-code-license/)
## Status These are the status icons for the requests so far. - ⌗ : must create resources to test - 🚧 : incomplete | untested - 🛑 : unsupported | bug
## Environment Variables This collection uses environment variables in scripts in the Tests tab to store data (id, name, portalId, etc.) between requests. This allows you to GET or POST then immediately GET {id} on a resource. Using No Environment will cause this convenience functionality to fail so be sure to choose one.
## Collection Variables This collection includes some default variables that you will want to update or override with environment variables for your ISE deployment. Specifically, you will want to set: - ise_pxg: the ISE PAN node name or IP address. Default: ise.securitydemo.net - rest_username: the username for ERS API access. Must be a member of SuperAdmin, ERSAdmin or ERSOperator groups. Default: admin which is the ISE SuperAdmin - rest_password: Default: C1sco12345
-
get_healths
(headers=None, **query_parameters)[source]¶ 🚧 getHealths.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_performances
(headers=None, **query_parameters)[source]¶ 🚧 getPerformances.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
system_certificate¶
-
class
SystemCertificate
[source]¶ Identity Services Engine SystemCertificate API (version: 3.1.0).
Wraps the Identity Services Engine SystemCertificate API and exposes the API as native Python methods that return native Python objects.
System Certificate API provides the ability to create certificates like SAML, pxGrid.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
3.0
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Example Values
name
String
Yes
Resource Name
id
String
No
Resource UUID, mandatory for update
description
String
No
Support Bundle Status api
nodeId
String
Yes
NodeId of Cisco ISE application
ISE-01
localCertStub
List
Yes
Inputs for certificate creation
subjectStub
List
No
Subject data of certificate
commonName
String
No
Common Name
$FQDN$
organizationalUnitName
String
No
Organizational Unit Name
Cisco-SAMLCert
organizationName
String
No
Organizational Name
Cisco
localityName
String
No
Locality Name
City
stateOrProvinceName
String
No
State or Province Name
State
countryName
String
No
Country Name
Country
keyType
String
Yes
Key Type
RSA OR ECDSA
keyLength
String
Yes
Key Length
512 OR 1024 OR 2048 OR 4096
digest
String
Yes
Digest
SHA-256 OR SHA-384 OR SHA-512
expirationTTL
Integer
Yes
Expiration Time to Live (TTL)
2
selectedExpirationTTLUnit
String
Yes
Selected Expiration TTL Unit
days OR weeks OR months OR years
groupTagDD
String
No
Group Tag DD
add-group-tag
samlCertificate
String
No
SAML Certificate
on OR off
xgridCertificate
String
No
XGrid Certificate
on OR off
friendlyName
String
No
Friendly Name
Cisco
allowWildcardCerts
String
No
Allow Wildcard Certificates
on OR off
certificateSanDns
String
No
Certificate SAN DNS
cisco.com
certificateSanIp
String
No
Certificate SAN IP
IP-ADDRESS
certificateSanUri
String
No
Certificate SAN URI
URI
certificatePolicies
String
No
Certificate Profiles
certificate policies
-
create_system_certificate
(ers_local_cert_stub=None, node_id=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to create a system certificate.
- Parameters
ers_local_cert_stub (object) – Inputs for certificate creation, property of the request body.
node_id (string) – NodeId of Cisco ISE application, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(ers_local_cert_stub=None, node_id=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_system_certificate
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the system certificate.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
tacacs_command_sets¶
-
class
TacacsCommandSets
[source]¶ Identity Services Engine TACACSCommandSets API (version: 3.1.0).
Wraps the Identity Services Engine TACACSCommandSets API and exposes the API as native Python methods that return native Python objects.
TACACS Command Sets API allows the client to add, delete, update, search and perform actions on TACACS command sets.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.4
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Default Values
Example Values
name
String
Yes
Resource Name
DenyAllCommands
id
String
No
Resource UUID, mandatory for update
0cef7990-6120-11ea-bffb-7a82c56e81f0
description
String
No
Default Command Set
permitUnmatched
Boolean
No
false
commands
List
No
Holds list of Commands
commandList
List
No
Array of dictionaries describing various attributes with the properties: - grant (Enum. Allowed values: PERMIT, DENY, DENY_ALWAYS), - command (String), - arguments (String)
[ { “grant” : “PERMIT”, “command” : “create”, “arguments” : “value” } ]
-
get_tacacs_command_sets_by_name
(name, headers=None, **query_parameters)[source]¶ This API allows the client to get TACACS command sets by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_name
(name, headers=None, **query_parameters)[source]¶ Alias for get_tacacs_command_sets_by_name
-
get_tacacs_command_sets_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get TACACS command sets by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_tacacs_command_sets_by_id
-
update_tacacs_command_sets_by_id
(id, commands=None, description=None, name=None, permit_unmatched=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update TACACS command sets.
- Parameters
commands (object) – commands, property of the request body.
description (string) – description, property of the request body.
id (basestring) – id, property of the request body.
name (string) – name, property of the request body.
permit_unmatched (boolean) – permitUnmatched, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, commands=None, description=None, name=None, permit_unmatched=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_tacacs_command_sets_by_id
-
delete_tacacs_command_sets_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes TACACS command sets.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_tacacs_command_sets_by_id
-
get_tacacs_command_sets
(page=None, size=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the TACACS command sets.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_tacacs_command_sets
-
get_tacacs_command_sets_generator
(page=None, size=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the TACACS command sets.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_tacacs_command_sets_generator
-
create_tacacs_command_sets
(commands=None, description=None, name=None, permit_unmatched=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates TACACS command sets.
- Parameters
commands (object) – commands, property of the request body.
description (string) – description, property of the request body.
name (string) – name, property of the request body.
permit_unmatched (boolean) – permitUnmatched, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(commands=None, description=None, name=None, permit_unmatched=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_tacacs_command_sets
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the TACACS command sets.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
tacacs_external_servers¶
-
class
TacacsExternalServers
[source]¶ Identity Services Engine TACACSExternalServers API (version: 3.1.0).
Wraps the Identity Services Engine TACACSExternalServers API and exposes the API as native Python methods that return native Python objects.
TACACS External Servers API allows the client to add, delete, update, search and perform actions on TACACS external servers.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.4
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Default Values
Example Values
name
String
Yes
Resource Name
TacacsExternalServer1
id
String
No
Resource UUID, mandatory for update
1af3d6e2-cc3b-4603-b80f-6827768335ab
description
String
No
TacacsExternalServerForSDK
hostIP
String
Yes
The server IPV4 address
1.1.1.1
connectionPort
Integer
No
The port to connect the server
49
singleConnect
Boolean
No
Define the use of single connection
true
sharedSecret
String
Yes
The server shared secret
SharedSecret
timeout
Integer
No
The server timeout
20
-
get_tacacs_external_servers_by_name
(name, headers=None, **query_parameters)[source]¶ This API allows the client to get TACACS external servers by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_name
(name, headers=None, **query_parameters)[source]¶ Alias for get_tacacs_external_servers_by_name
-
get_tacacs_external_servers_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get TACACS external servers by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_tacacs_external_servers_by_id
-
update_tacacs_external_servers_by_id
(id, connection_port=None, description=None, host_ip=None, name=None, shared_secret=None, single_connect=None, timeout=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update TACACS external servers.
- Parameters
connection_port (integer) – The port to connect the server, property of the request body.
description (string) – description, property of the request body.
host_ip (string) – The server IPV4 address, property of the request body.
id (basestring) – id, property of the request body.
name (string) – name, property of the request body.
shared_secret (string) – The server shared secret, property of the request body.
single_connect (boolean) – Define the use of single connection, property of the request body.
timeout (integer) – The server timeout, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, connection_port=None, description=None, host_ip=None, name=None, shared_secret=None, single_connect=None, timeout=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_tacacs_external_servers_by_id
-
delete_tacacs_external_servers_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes TACACS external servers.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_tacacs_external_servers_by_id
-
get_tacacs_external_servers
(page=None, size=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the TACACS external servers.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_tacacs_external_servers
-
get_tacacs_external_servers_generator
(page=None, size=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the TACACS external servers.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_tacacs_external_servers_generator
-
create_tacacs_external_servers
(connection_port=None, description=None, host_ip=None, name=None, shared_secret=None, single_connect=None, timeout=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates TACACS external servers.
- Parameters
connection_port (integer) – The port to connect the server, property of the request body.
description (string) – description, property of the request body.
host_ip (string) – The server IPV4 address, property of the request body.
name (string) – name, property of the request body.
shared_secret (string) – The server shared secret, property of the request body.
single_connect (boolean) – Define the use of single connection, property of the request body.
timeout (integer) – The server timeout, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(connection_port=None, description=None, host_ip=None, name=None, shared_secret=None, single_connect=None, timeout=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_tacacs_external_servers
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the TACACS external servers.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
tacacs_profile¶
-
class
TacacsProfile
[source]¶ Identity Services Engine TACACSProfile API (version: 3.1.0).
Wraps the Identity Services Engine TACACSProfile API and exposes the API as native Python methods that return native Python objects.
TACACS Profile API allows the client to add, delete, update, search and perform actions on TACACS profile.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.4
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Example Values
name
String
Yes
Resource Name
Default Shell Profile
id
String
No
Resource UUID, mandatory for update
93d7ee70-92b5-11eb-a39d-96858bc78604
description
String
No
Default Shell Profile
sessionAttributes
List
No
Holds list of session attributes. View type for GUI is Shell by default
sessionAttributeList
List
No
Array of dictionaries describing various attributes with the properties: - type (Enum. Allowed values: MANDATORY, OPTIONAL), - name (String), - value (String)
[ { “type” : “MANDATORY”, “name” : “attr1”, “value” : “value” } ]
-
get_tacacs_profile_by_name
(name, headers=None, **query_parameters)[source]¶ This API allows the client to get a TACACS profile by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_name
(name, headers=None, **query_parameters)[source]¶ Alias for get_tacacs_profile_by_name
-
get_tacacs_profile_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get a TACACS profile by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_tacacs_profile_by_id
-
update_tacacs_profile_by_id
(id, description=None, name=None, session_attributes=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update a TACACS profile.
- Parameters
description (string) – description, property of the request body.
id (basestring) – id, property of the request body.
name (string) – name, property of the request body.
session_attributes (object) – Holds list of session attributes. View type for GUI is Shell by default, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, description=None, name=None, session_attributes=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_tacacs_profile_by_id
-
delete_tacacs_profile_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes a TACACS profile.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_tacacs_profile_by_id
-
get_tacacs_profile
(page=None, size=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the TACACS profiles.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_tacacs_profile
-
get_tacacs_profile_generator
(page=None, size=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the TACACS profiles.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_tacacs_profile_generator
-
create_tacacs_profile
(description=None, name=None, session_attributes=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates a TACACS profile.
- Parameters
description (string) – description, property of the request body.
name (string) – name, property of the request body.
session_attributes (object) – Holds list of session attributes. View type for GUI is Shell by default, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(description=None, name=None, session_attributes=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_tacacs_profile
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the TACACS profile.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
tacacs_server_sequence¶
-
class
TacacsServerSequence
[source]¶ Identity Services Engine TacacsServerSequence API (version: 3.1.0).
Wraps the Identity Services Engine TacacsServerSequence API and exposes the API as native Python methods that return native Python objects.
TACACS Server Sequence API aallows the client to add, delete, update, search and perform actions on TACACS server sequence.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.4
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Default Values
Example Values
name
String
Yes
Resource Name
TacacsServerSequence1
id
String
No
Resource UUID, mandatory for update
1af3d6e2-cc3b-4603-b80f-6827768335ab
description
String
No
TacacsServerSequenceForSDK
serverList
String
Yes
The names of Tacacs external servers separated by commas. The order of the names in the string is the order of servers that will be used during authentication
TacacsExternalServer1,TacacsExternalServer2
localAccounting
Boolean
No
false
remoteAccounting
Boolean
No
true
prefixStrip
Boolean
No
Define if a delimiter will be used for prefix strip
false
suffixStrip
Boolean
No
Define if a delimiter will be used for suffix strip
false
prefixDelimiter
String
No
The delimiter that will be used for prefix strip
suffixDelimiter
String
No
The delimiter that will be used for suffix strip
@
-
get_tacacs_server_sequence_by_name
(name, headers=None, **query_parameters)[source]¶ This API allows the client to get a TACACS server sequence by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_name
(name, headers=None, **query_parameters)[source]¶ Alias for get_tacacs_server_sequence_by_name
-
get_tacacs_server_sequence_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get a TACACS server sequence by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_tacacs_server_sequence_by_id
-
update_tacacs_server_sequence_by_id
(id, description=None, local_accounting=None, name=None, prefix_delimiter=None, prefix_strip=None, remote_accounting=None, server_list=None, suffix_delimiter=None, suffix_strip=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update a TACACS server sequence.
- Parameters
description (string) – description, property of the request body.
id (basestring) – id, property of the request body.
local_accounting (boolean) – localAccounting, property of the request body.
name (string) – name, property of the request body.
prefix_delimiter (string) – The delimiter that will be used for prefix strip, property of the request body.
prefix_strip (boolean) – Define if a delimiter will be used for prefix strip, property of the request body.
remote_accounting (boolean) – remoteAccounting, property of the request body.
server_list (string) – The names of Tacacs external servers separated by commas. The order of the names in the string is the order of servers that will be used during authentication, property of the request body.
suffix_delimiter (string) – The delimiter that will be used for suffix strip, property of the request body.
suffix_strip (boolean) – Define if a delimiter will be used for suffix strip, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, description=None, local_accounting=None, name=None, prefix_delimiter=None, prefix_strip=None, remote_accounting=None, server_list=None, suffix_delimiter=None, suffix_strip=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_tacacs_server_sequence_by_id
-
delete_tacacs_server_sequence_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes a TACACS server sequence.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_tacacs_server_sequence_by_id
-
get_tacacs_server_sequence
(page=None, size=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the TACACS server sequences.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_tacacs_server_sequence
-
get_tacacs_server_sequence_generator
(page=None, size=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the TACACS server sequences.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_tacacs_server_sequence_generator
-
create_tacacs_server_sequence
(description=None, local_accounting=None, name=None, prefix_delimiter=None, prefix_strip=None, remote_accounting=None, server_list=None, suffix_delimiter=None, suffix_strip=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates a TACACS server sequence.
- Parameters
description (string) – description, property of the request body.
local_accounting (boolean) – localAccounting, property of the request body.
name (string) – name, property of the request body.
prefix_delimiter (string) – The delimiter that will be used for prefix strip, property of the request body.
prefix_strip (boolean) – Define if a delimiter will be used for prefix strip, property of the request body.
remote_accounting (boolean) – remoteAccounting, property of the request body.
server_list (string) – The names of Tacacs external servers separated by commas. The order of the names in the string is the order of servers that will be used during authentication, property of the request body.
suffix_delimiter (string) – The delimiter that will be used for suffix strip, property of the request body.
suffix_strip (boolean) – Define if a delimiter will be used for suffix strip, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(description=None, local_accounting=None, name=None, prefix_delimiter=None, prefix_strip=None, remote_accounting=None, server_list=None, suffix_delimiter=None, suffix_strip=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_tacacs_server_sequence
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the TACACS server sequence.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
telemetry_information¶
-
class
TelemetryInformation
[source]¶ Identity Services Engine TelemetryInformation API (version: 3.1.0).
Wraps the Identity Services Engine TelemetryInformation API and exposes the API as native Python methods that return native Python objects.
Telemetry Information API allows clients to get telemetry configuration information.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
3.0
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Example Values
name
String
Yes
Resource Name
id
String
No
Resource UUID, mandatory for update
ed7176fb-3faf-4060-845e-d5fa5236bd6e
description
String
No
status
String
No
SCHEnable
deploymentId
String
No
ed7176fb-3faf-4060-845e-d5fa5236bd6e
udiSN
String
No
CH2MKIEGBGO
-
get_telemetry_info_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get telemetry information by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_telemetry_info_by_id
-
get_telemetry_information
(filter=None, filter_type=None, page=None, size=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the telemetry information. Filter: [deploymentId] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 .
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_telemetry_information
-
get_telemetry_information_generator
(filter=None, filter_type=None, page=None, size=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the telemetry information. Filter: [deploymentId] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 .
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_telemetry_information_generator
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the telemetry information.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
trust_sec_configuration¶
-
class
TrustSecConfiguration
[source]¶ Identity Services Engine TrustSec Configuration API (version: 3.1.0).
Wraps the Identity Services Engine TrustSec Configuration API and exposes the API as native Python methods that return native Python objects.
# Cisco ISE 3.0 pxGrid REST APIs
## License [Cisco Sample Code License](https://developer.cisco.com/site/license/cisco-sample-code-license/)
## Status These are the status icons for the requests so far. - ⌗ : must create resources to test - 🚧 : incomplete | untested - 🛑 : unsupported | bug
## Environment Variables This collection uses environment variables in scripts in the Tests tab to store data (id, name, portalId, etc.) between requests. This allows you to GET or POST then immediately GET {id} on a resource. Using No Environment will cause this convenience functionality to fail so be sure to choose one.
## Collection Variables This collection includes some default variables that you will want to update or override with environment variables for your ISE deployment. Specifically, you will want to set: - ise_pxg: the ISE PAN node name or IP address. Default: ise.securitydemo.net - rest_username: the username for ERS API access. Must be a member of SuperAdmin, ERSAdmin or ERSOperator groups. Default: admin which is the ISE SuperAdmin - rest_password: Default: C1sco12345
-
get_security_groups
(headers=None, **query_parameters)[source]¶ 🚧 getSecurityGroups.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(headers=None, **query_parameters)[source]¶ Alias for get_security_groups
-
get_security_group_acls
(headers=None, **query_parameters)[source]¶ 🚧 getSecurityGroupAcls.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_egress_policies
(headers=None, **query_parameters)[source]¶ 🚧 getEgressPolicies.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_egress_matrices
(headers=None, **query_parameters)[source]¶ 🚧 getEgressMatrices.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
trust_sec_sxp¶
-
class
TrustSecSxp
[source]¶ Identity Services Engine TrustSec SXP API (version: 3.1.0).
Wraps the Identity Services Engine TrustSec SXP API and exposes the API as native Python methods that return native Python objects.
# Cisco ISE 3.0 pxGrid REST APIs
## License [Cisco Sample Code License](https://developer.cisco.com/site/license/cisco-sample-code-license/)
## Status These are the status icons for the requests so far. - ⌗ : must create resources to test - 🚧 : incomplete | untested - 🛑 : unsupported | bug
## Environment Variables This collection uses environment variables in scripts in the Tests tab to store data (id, name, portalId, etc.) between requests. This allows you to GET or POST then immediately GET {id} on a resource. Using No Environment will cause this convenience functionality to fail so be sure to choose one.
## Collection Variables This collection includes some default variables that you will want to update or override with environment variables for your ISE deployment. Specifically, you will want to set: - ise_pxg: the ISE PAN node name or IP address. Default: ise.securitydemo.net - rest_username: the username for ERS API access. Must be a member of SuperAdmin, ERSAdmin or ERSOperator groups. Default: admin which is the ISE SuperAdmin - rest_password: Default: C1sco12345
-
get_bindings
(headers=None, **query_parameters)[source]¶ 🚧 getBindings.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
version_and_patch¶
-
class
VersionAndPatch
[source]¶ Identity Services Engine VersionAndPatch API (version: 3.1.0).
Wraps the Identity Services Engine VersionAndPatch API and exposes the API as native Python methods that return native Python objects.
Version and Patch API is used to provide the Cisco ISE version on which the Cisco ISE cluster is running, and a comma-separated list of the patches that are installed. The highest numbered patch is the patch that the cluster in running on.
-
get_ise_version_and_patch
(headers=None, **query_parameters)[source]¶ This API allows the client to get Cisco ISE version and patch information.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(headers=None, **query_parameters)[source]¶ Alias for get_ise_version_and_patch
-
version_info¶
-
class
VersionInfo
[source]¶ Identity Services Engine VersionInfo API (version: 3.1.0).
Wraps the Identity Services Engine VersionInfo API and exposes the API as native Python methods that return native Python objects.
Version and Patch API is used to provide the Cisco ISE version on which the Cisco ISE cluster is running, and a comma-separated list of the patches that are installed. The highest numbered patch is the patch that the cluster in running on.
-
get_version_info
(resource, headers=None, **query_parameters)[source]¶ Get all VersionInfo.
- Parameters
resource (basestring) – resource path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
endpoint¶
-
class
Endpoint
[source]¶ Identity Services Engine endpoint API (version: 3.1.0).
Wraps the Identity Services Engine endpoint API and exposes the API as native Python methods that return native Python objects.
Endpoint API allows the client to add, delete, update, search, register and de-register endpoints. Please note that each API description shows whether the API is supported in bulk operation. The Bulk section is showing only ‘create’ bulk operation however, all other operation which are bulk supported can be used in same way.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
Revision Modification
Attribute
Description
0
1.0
1.3
Initial Cisco ISE Version
1
1.1
2.1
Cisco ISE 2.1 model changes
customAttributes
Added custom attibutes for the user to include custom attributes when adding endpoints to Cisco ISE
2
1.2
2.2
Cisco ISE 2.2 model changes
apiAdded
Added custom operation to get list of rejected endpoints: ‘/getrejectedendpoints’
apiAdded
Added custom operation to release rejected endpoint: ‘{id}/releaserejectedendpoint’
Resource Definition
Attribute
Type
Required
Description
Example Values
name
String
Yes
Resource Name
11:22:33:44:55:66
id
String
No
Resource UUID, mandatory for update
172f8270-8f4f-11eb-b4a8-9eb04987ed29
description
String
No
MyEndpoint
customAttributes
Map
No
Key value map
{“key1” : “value1”}
groupId
String
Yes
aa13bb40-8bff-11e6-996c-525400b48521
identityStore
String
No
identityStore
identityStoreId
String
No
identityStoreId
mac
String
Yes
11:22:33:44:55:66
portalUser
String
No
portalUser
profileId
String
No
profileId
staticGroupAssignment
Boolean
Yes
true
staticProfileAssignment
Boolean
Yes
false
-
release_rejected_endpoint
(id, headers=None, **query_parameters)[source]¶ This API allows the client to release a rejected endpoint.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
release_rejected
(id, headers=None, **query_parameters)[source]¶ Alias for release_rejected_endpoint
-
deregister_endpoint
(id, headers=None, **query_parameters)[source]¶ This API allows the client to de-register an endpoint.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
deregister
(id, headers=None, **query_parameters)[source]¶ Alias for deregister_endpoint
-
get_rejected_endpoints
(headers=None, **query_parameters)[source]¶ This API allows the client to get the rejected endpoints.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_rejected
(headers=None, **query_parameters)[source]¶ Alias for get_rejected_endpoints
-
get_endpoint_by_name
(name, headers=None, **query_parameters)[source]¶ This API allows the client to get an endpoint by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_name
(name, headers=None, **query_parameters)[source]¶ Alias for get_endpoint_by_name
-
get_endpoint_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get an endpoint by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_endpoint_by_id
-
update_endpoint_by_id
(id, custom_attributes=None, description=None, group_id=None, identity_store=None, identity_store_id=None, mac=None, mdm_attributes=None, name=None, portal_user=None, profile_id=None, static_group_assignment=None, static_profile_assignment=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update an endpoint.
- Parameters
custom_attributes (object) – customAttributes, property of the request body.
description (string) – description, property of the request body.
group_id (string) – groupId, property of the request body.
id (basestring) – id, property of the request body.
identity_store (string) – identityStore, property of the request body.
identity_store_id (string) – identityStoreId, property of the request body.
mac (string) – mac, property of the request body.
mdm_attributes (object) – mdmAttributes, property of the request body.
name (string) – name, property of the request body.
portal_user (string) – portalUser, property of the request body.
profile_id (string) – profileId, property of the request body.
static_group_assignment (boolean) – staticGroupAssignment, property of the request body.
static_profile_assignment (boolean) – staticProfileAssignment, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, custom_attributes=None, description=None, group_id=None, identity_store=None, identity_store_id=None, mac=None, mdm_attributes=None, name=None, portal_user=None, profile_id=None, static_group_assignment=None, static_profile_assignment=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_endpoint_by_id
-
delete_endpoint_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes an endpoint.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_endpoint_by_id
-
register_endpoint
(custom_attributes=None, description=None, group_id=None, id=None, identity_store=None, identity_store_id=None, mac=None, mdm_attributes=None, name=None, portal_user=None, profile_id=None, static_group_assignment=None, static_profile_assignment=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to register an endpoint.
- Parameters
custom_attributes (object) – customAttributes, property of the request body.
description (string) – description, property of the request body.
group_id (string) – groupId, property of the request body.
id (string) – id, property of the request body.
identity_store (string) – identityStore, property of the request body.
identity_store_id (string) – identityStoreId, property of the request body.
mac (string) – mac, property of the request body.
mdm_attributes (object) – mdmAttributes, property of the request body.
name (string) – name, property of the request body.
portal_user (string) – portalUser, property of the request body.
profile_id (string) – profileId, property of the request body.
static_group_assignment (boolean) – staticGroupAssignment, property of the request body.
static_profile_assignment (boolean) – staticProfileAssignment, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
register
(custom_attributes=None, description=None, group_id=None, id=None, identity_store=None, identity_store_id=None, mac=None, mdm_attributes=None, name=None, portal_user=None, profile_id=None, static_group_assignment=None, static_profile_assignment=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for register_endpoint
-
get_endpoints
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the endpoints. Filter: Filters can be used to filter out Endpoints based on a set of attributes. This API currently provides the following filters: [logicalProfileName, portalUser, staticProfileAssignment, profileId, profile, groupId, staticGroupAssignment, mac] Example 1: The logicalProfileName filter can be used to get Enpoints that belong to a specific Logical Profile. The supported operator for logicalProfileNamefilter is EQ (equal to). The syntax to invoke the API with this filter: /ers/config/endpoint?filter={filter name}.{operator}.{logical profile name} Example: https://{ise-ip}:9060/ers/config/endpoint?filter=logical ProfileName.EQ.LP_Apple Example 2: To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_endpoints
-
get_endpoints_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the endpoints. Filter: Filters can be used to filter out Endpoints based on a set of attributes. This API currently provides the following filters: [logicalProfileName, portalUser, staticProfileAssignment, profileId, profile, groupId, staticGroupAssignment, mac] Example 1: The logicalProfileName filter can be used to get Enpoints that belong to a specific Logical Profile. The supported operator for logicalProfileNamefilter is EQ (equal to). The syntax to invoke the API with this filter: /ers/config/endpoint?filter={filter name}.{operator}.{logical profile name} Example: https://{ise-ip}:9060/ers/config/endpoint?filter=logical ProfileName.EQ.LP_Apple Example 2: To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_endpoints_generator
-
create_endpoint
(custom_attributes=None, description=None, group_id=None, identity_store=None, identity_store_id=None, mac=None, mdm_attributes=None, name=None, portal_user=None, profile_id=None, static_group_assignment=None, static_profile_assignment=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates an endpoint.
- Parameters
custom_attributes (object) – customAttributes, property of the request body.
description (string) – description, property of the request body.
group_id (string) – groupId, property of the request body.
identity_store (string) – identityStore, property of the request body.
identity_store_id (string) – identityStoreId, property of the request body.
mac (string) – mac, property of the request body.
mdm_attributes (object) – mdmAttributes, property of the request body.
name (string) – name, property of the request body.
portal_user (string) – portalUser, property of the request body.
profile_id (string) – profileId, property of the request body.
static_group_assignment (boolean) – staticGroupAssignment, property of the request body.
static_profile_assignment (boolean) – staticProfileAssignment, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(custom_attributes=None, description=None, group_id=None, identity_store=None, identity_store_id=None, mac=None, mdm_attributes=None, name=None, portal_user=None, profile_id=None, static_group_assignment=None, static_profile_assignment=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_endpoint
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the endpoint.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
bulk_request_for_endpoint
(operation_type=None, resource_media_type=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to submit the bulk request.
- Parameters
operation_type (string) – operationType, property of the request body.
resource_media_type (string) – resourceMediaType, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
bulk_request
(operation_type=None, resource_media_type=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for bulk_request_for_endpoint
-
monitor_bulk_status_endpoint
(bulkid, headers=None, **query_parameters)[source]¶ This API allows the client to monitor the bulk request.
- Parameters
bulkid (basestring) – bulkid path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
monitor_bulk_status
(bulkid, headers=None, **query_parameters)[source]¶ Alias for monitor_bulk_status_endpoint
-
nbar_app¶
-
class
NbarApp
[source]¶ Identity Services Engine nbarApp API (version: 3.1.0).
Wraps the Identity Services Engine nbarApp API and exposes the API as native Python methods that return native Python objects.
-
get_nbar_apps
(filter=None, filter_type=None, page=None, size=None, sort=None, sort_by=None, headers=None, **query_parameters)[source]¶ Get all NBAR Applications.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sort (basestring) – sort query parameter. sort type asc or desc.
sort_by (basestring) – sortBy query parameter. sort column by which objects needs to be sorted.
filter (basestring) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. OPERATOR DESCRIPTION EQ Equals NEQ Not Equals GT Greater Than LT Less Then STARTSW Starts With NSTARTSW Not Starts With ENDSW Ends With NENDSW Not Ends With CONTAINS Contains NCONTAINS Not Contains .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sort=None, sort_by=None, headers=None, **query_parameters)[source]¶ Alias for get_nbar_apps
-
get_nbar_apps_generator
(filter=None, filter_type=None, page=None, size=None, sort=None, sort_by=None, headers=None, **query_parameters)[source]¶ Get all NBAR Applications.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sort (basestring) – sort query parameter. sort type asc or desc.
sort_by (basestring) – sortBy query parameter. sort column by which objects needs to be sorted.
filter (basestring) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. OPERATOR DESCRIPTION EQ Equals NEQ Not Equals GT Greater Than LT Less Then STARTSW Starts With NSTARTSW Not Starts With ENDSW Ends With NENDSW Not Ends With CONTAINS Contains NCONTAINS Not Contains .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sort=None, sort_by=None, headers=None, **query_parameters)[source]¶ Alias for get_nbar_apps_generator
-
create_nbar_app
(description=None, id=None, name=None, network_identities=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Create NBAR application.
- Parameters
description (string) – description, property of the request body.
id (string) – id, property of the request body.
name (string) – name, property of the request body.
network_identities (list) – Array of NIs, property of the request body (list of objects).
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(description=None, id=None, name=None, network_identities=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_nbar_app
-
get_nbar_app_by_id
(id, headers=None, **query_parameters)[source]¶ Get NBAR Application by id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_nbar_app_by_id
-
update_nbar_app_by_id
(id, description=None, name=None, network_identities=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Update NBAR Application.
- Parameters
description (string) – description, property of the request body.
id (basestring) – id, property of the request body.
name (string) – name, property of the request body.
network_identities (list) – Array of NIs, property of the request body (list of objects).
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, description=None, name=None, network_identities=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_nbar_app_by_id
-
delete_nbar_app_by_id
(id, headers=None, **query_parameters)[source]¶ Delete NBAR Application.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_nbar_app_by_id
-
portal¶
-
class
Portal
[source]¶ Identity Services Engine portal API (version: 3.1.0).
Wraps the Identity Services Engine portal API and exposes the API as native Python methods that return native Python objects.
Portal API allows the client to search profiles.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
1.2
Initial Cisco ISE Version
1
2.0
1.3
Introducing new schema - not supporting 1.0 anymore
Resource Definition
Attribute
Type
Required
Description
Example Values
name
String
Yes
Resource Name
ISE Portal (default)
id
String
No
Resource UUID, mandatory for update
bc5524ea-b1e5-47ed-a907-5304821da916
description
String
No
ISE Portal for saml based feature purpose
portalType
String
No
GUEST
-
get_portal_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get a portal by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_portal_by_id
-
get_portals
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the portals. Filter: [name, description] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_portals
-
get_portals_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the portals. Filter: [name, description] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_portals_generator
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information realted to the portal.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
px_grid_node¶
-
class
PxGridNode
[source]¶ Identity Services Engine pxGridNode API (version: 3.1.0).
Wraps the Identity Services Engine pxGridNode API and exposes the API as native Python methods that return native Python objects.
pxGrid Node API allows the client to retrieve pxGrid information, delete an existing pxGrid node, and approve new pxGrid nodes. Note: From Cisco ISE Release 3.1, all pxGrid connections must be based on pxGrid 2.0. pxGrid 1.0-based (XMPP-based) integrations will cease to work on Cisco ISE from Release 3.1 onwards. pxGrid Version 2.0, which is based on WebSockets, was introduced in Cisco ISE Release 2.4. We recommend that you plan and upgrade your other systems to pxGrid 2.0-compliant versions in order to prevent potential disruptions, if any, to integrations.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.4
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Example Values
name
String
Yes
Resource Name
ers-sample-client
id
String
No
Resource UUID, mandatory for update
ab6deded-fcc2-47ff-8577-0014737c8fcf
description
String
No
ERS sample client
status
String
No
Online (XMPP)
authMethod
String
No
Certificate
groups
String
No
pxGrid Characterization
Session data Consumption over pxGrid
On a 35 node Cisco ISE deployment with a dedicated primary Policy Administration node (PAN), dedicated secondary PAN, dedicated primary Monitoring and Troubleshooting node (MnT node), dedicated secondary MnT, dedicated pxGrid node and 30 heterogeneous Policy Service node (PSN) platforms, there was no delay observed in consuming session data with the following parameters as shown in the table below:
RADIUS Traffic
Total number of sessions in the deployment
Number of pxGrid clients (subscribers to the session topic)
pxGrid client’s delay in consuming session data
Upto 500 transactions per second (TPS)
~2 million
50
No delay
Bulk download time taken
On a 35 node Cisco ISE deployment with a dedicated primary PAN, dedicated secondary PAN, dedicated primary MnT, dedicated secondary MnT, dedicated pxGrid node and 30 heterogeneous PSN Platforms, the bulk download time for all the pxGrid clients is shown in the table below:
Total number of sessions in the deployment
Number of pxGrid clients (subscribers to the session topic)
Time taken for bulk download
2 million
50
~17 minutes
Note: From Cisco ISE Release 3.1, we can use either pxgridnode or pxgridNode in the URL.-
approve_px_grid_node
(name, headers=None, **query_parameters)[source]¶ This API allows the client to approve a pxGrid node. Only pending pxGrid nodes can be approved.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
approve
(name, headers=None, **query_parameters)[source]¶ Alias for approve_px_grid_node
-
get_px_grid_node_by_name
(name, headers=None, **query_parameters)[source]¶ This API allows the client to get a pxGrid node by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_name
(name, headers=None, **query_parameters)[source]¶ Alias for get_px_grid_node_by_name
-
delete_px_grid_node_by_name
(name, headers=None, **query_parameters)[source]¶ This API deletes a pxGrid node by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_name
(name, headers=None, **query_parameters)[source]¶ Alias for delete_px_grid_node_by_name
-
get_px_grid_node_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get a pxGrid node by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_px_grid_node_by_id
-
get_px_grid_node
(page=None, size=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the npxGrid nodes.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_px_grid_node
-
get_px_grid_node_generator
(page=None, size=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the npxGrid nodes.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_px_grid_node_generator
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the pxGrid node.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
sg_vn_mapping¶
-
class
SgVnMapping
[source]¶ Identity Services Engine sgVnMapping API (version: 3.1.0).
Wraps the Identity Services Engine sgVnMapping API and exposes the API as native Python methods that return native Python objects.
-
get_sg_vn_mappings
(filter=None, filter_type=None, page=None, size=None, sort=None, sort_by=None, headers=None, **query_parameters)[source]¶ Get all Security Group and Virtual Network mappings.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sort (basestring) – sort query parameter. sort type asc or desc.
sort_by (basestring) – sortBy query parameter. sort column by which objects needs to be sorted.
filter (basestring) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. OPERATOR DESCRIPTION EQ Equals NEQ Not Equals GT Greater Than LT Less Then STARTSW Starts With NSTARTSW Not Starts With ENDSW Ends With NENDSW Not Ends With CONTAINS Contains NCONTAINS Not Contains .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sort=None, sort_by=None, headers=None, **query_parameters)[source]¶ Alias for get_sg_vn_mappings
-
get_sg_vn_mappings_generator
(filter=None, filter_type=None, page=None, size=None, sort=None, sort_by=None, headers=None, **query_parameters)[source]¶ Get all Security Group and Virtual Network mappings.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sort (basestring) – sort query parameter. sort type asc or desc.
sort_by (basestring) – sortBy query parameter. sort column by which objects needs to be sorted.
filter (basestring) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. OPERATOR DESCRIPTION EQ Equals NEQ Not Equals GT Greater Than LT Less Then STARTSW Starts With NSTARTSW Not Starts With ENDSW Ends With NENDSW Not Ends With CONTAINS Contains NCONTAINS Not Contains .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sort=None, sort_by=None, headers=None, **query_parameters)[source]¶ Alias for get_sg_vn_mappings_generator
-
create_sg_vn_mapping
(id=None, last_update=None, sg_name=None, sgt_id=None, vn_id=None, vn_name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Create Security Group and Virtual Network mapping.
- Parameters
id (string) – Identifier of the SG-VN mapping, property of the request body.
last_update (string) – Timestamp for the last update of the SG-VN mapping, property of the request body.
sg_name (string) – Name of the associated Security Group to be used for identity if id is not provided, property of the request body.
sgt_id (string) – Identifier of the associated Security Group which is required unless its name is provided, property of the request body.
vn_id (string) – Identifier for the associated Virtual Network which is required unless its name is provided, property of the request body.
vn_name (string) – Name of the associated Virtual Network to be used for identity if id is not provided, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(id=None, last_update=None, sg_name=None, sgt_id=None, vn_id=None, vn_name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_sg_vn_mapping
-
bulk_create_sg_vn_mappings
(headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Create SG-VN Mappings in bulk.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (list) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
bulk_request_create
(headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for bulk_create_sg_vn_mappings
-
bulk_delete_sg_vn_mappings
(headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Delete SG-VN Mappings in bulk.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (list) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
bulk_request_delete
(headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for bulk_delete_sg_vn_mappings
-
bulk_update_sg_vn_mappings
(headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Update SG-VN Mappings in bulk.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (list) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
bulk_request_update
(headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for bulk_update_sg_vn_mappings
-
get_sg_vn_mapping_by_id
(id, headers=None, **query_parameters)[source]¶ Get Security Group and Virtual Network mapping by id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_sg_vn_mapping_by_id
-
update_sg_vn_mapping_by_id
(id, last_update=None, sg_name=None, sgt_id=None, vn_id=None, vn_name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Update Security Group and Virtual Network mapping.
- Parameters
id (basestring) – Identifier of the SG-VN mapping, property of the request body.
last_update (string) – Timestamp for the last update of the SG-VN mapping, property of the request body.
sg_name (string) – Name of the associated Security Group to be used for identity if id is not provided, property of the request body.
sgt_id (string) – Identifier of the associated Security Group which is required unless its name is provided, property of the request body.
vn_id (string) – Identifier for the associated Virtual Network which is required unless its name is provided, property of the request body.
vn_name (string) – Name of the associated Virtual Network to be used for identity if id is not provided, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, last_update=None, sg_name=None, sgt_id=None, vn_id=None, vn_name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_sg_vn_mapping_by_id
-
delete_sg_vn_mapping_by_id
(id, headers=None, **query_parameters)[source]¶ Delete Security Group and Virtual Network mapping.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_sg_vn_mapping_by_id
-
tasks¶
-
class
Tasks
[source]¶ Identity Services Engine tasks API (version: 3.1.0).
Wraps the Identity Services Engine tasks API and exposes the API as native Python methods that return native Python objects.
-
get_task_status
(headers=None, **query_parameters)[source]¶ get all task status.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(list): A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_task_status_by_id
(task_id, headers=None, **query_parameters)[source]¶ Monitor task status.
- Parameters
task_id (basestring) – taskId path parameter. The id of the task executed before.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
virtual_network¶
-
class
VirtualNetwork
[source]¶ Identity Services Engine virtualNetwork API (version: 3.1.0).
Wraps the Identity Services Engine virtualNetwork API and exposes the API as native Python methods that return native Python objects.
-
get_virtual_networks
(filter=None, filter_type=None, page=None, size=None, sort=None, sort_by=None, headers=None, **query_parameters)[source]¶ Get all Virtual Networks.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sort (basestring) – sort query parameter. sort type asc or desc.
sort_by (basestring) – sortBy query parameter. sort column by which objects needs to be sorted.
filter (basestring) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. OPERATOR DESCRIPTION EQ Equals NEQ Not Equals GT Greater Than LT Less Then STARTSW Starts With NSTARTSW Not Starts With ENDSW Ends With NENDSW Not Ends With CONTAINS Contains NCONTAINS Not Contains .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sort=None, sort_by=None, headers=None, **query_parameters)[source]¶ Alias for get_virtual_networks
-
get_virtual_networks_generator
(filter=None, filter_type=None, page=None, size=None, sort=None, sort_by=None, headers=None, **query_parameters)[source]¶ Get all Virtual Networks.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sort (basestring) – sort query parameter. sort type asc or desc.
sort_by (basestring) – sortBy query parameter. sort column by which objects needs to be sorted.
filter (basestring) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. OPERATOR DESCRIPTION EQ Equals NEQ Not Equals GT Greater Than LT Less Then STARTSW Starts With NSTARTSW Not Starts With ENDSW Ends With NENDSW Not Ends With CONTAINS Contains NCONTAINS Not Contains .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sort=None, sort_by=None, headers=None, **query_parameters)[source]¶ Alias for get_virtual_networks_generator
-
create_virtual_network
(additional_attributes=None, id=None, last_update=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Create Virtual Network.
- Parameters
additional_attributes (string) – JSON String of additional attributes for the Virtual Network, property of the request body.
id (string) – Identifier of the Virtual Network, property of the request body.
last_update (string) – Timestamp for the last update of the Virtual Network, property of the request body.
name (string) – Name of the Virtual Network, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(additional_attributes=None, id=None, last_update=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_virtual_network
-
bulk_create_virtual_networks
(headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Create Virtual Network in bulk.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (list) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
bulk_request_create
(headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for bulk_create_virtual_networks
-
bulk_delete_virtual_networks
(headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Delete Virtual Network in bulk.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (list) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
bulk_request_delete
(headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for bulk_delete_virtual_networks
-
bulk_update_virtual_networks
(headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Update Virtual Network in bulk.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (list) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
bulk_request_update
(headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for bulk_update_virtual_networks
-
get_virtual_network_by_id
(id, headers=None, **query_parameters)[source]¶ Get Virtual Network by id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_virtual_network_by_id
-
update_virtual_network_by_id
(id, additional_attributes=None, last_update=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Update Virtual Network.
- Parameters
additional_attributes (string) – JSON String of additional attributes for the Virtual Network, property of the request body.
id (basestring) – Identifier of the Virtual Network, property of the request body.
last_update (string) – Timestamp for the last update of the Virtual Network, property of the request body.
name (string) – Name of the Virtual Network, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, additional_attributes=None, last_update=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_virtual_network_by_id
-
delete_virtual_network_by_id
(id, headers=None, **query_parameters)[source]¶ Delete Virtual Network.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_virtual_network_by_id
-
vn_vlan_mapping¶
-
class
VnVlanMapping
[source]¶ Identity Services Engine vnVlanMapping API (version: 3.1.0).
Wraps the Identity Services Engine vnVlanMapping API and exposes the API as native Python methods that return native Python objects.
-
get_vn_vlan_mappings
(filter=None, filter_type=None, page=None, size=None, sort=None, sort_by=None, headers=None, **query_parameters)[source]¶ Get all VN-Vlan Mappings.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sort (basestring) – sort query parameter. sort type asc or desc.
sort_by (basestring) – sortBy query parameter. sort column by which objects needs to be sorted.
filter (basestring) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. OPERATOR DESCRIPTION EQ Equals NEQ Not Equals GT Greater Than LT Less Then STARTSW Starts With NSTARTSW Not Starts With ENDSW Ends With NENDSW Not Ends With CONTAINS Contains NCONTAINS Not Contains .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sort=None, sort_by=None, headers=None, **query_parameters)[source]¶ Alias for get_vn_vlan_mappings
-
get_vn_vlan_mappings_generator
(filter=None, filter_type=None, page=None, size=None, sort=None, sort_by=None, headers=None, **query_parameters)[source]¶ Get all VN-Vlan Mappings.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sort (basestring) – sort query parameter. sort type asc or desc.
sort_by (basestring) – sortBy query parameter. sort column by which objects needs to be sorted.
filter (basestring) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. OPERATOR DESCRIPTION EQ Equals NEQ Not Equals GT Greater Than LT Less Then STARTSW Starts With NSTARTSW Not Starts With ENDSW Ends With NENDSW Not Ends With CONTAINS Contains NCONTAINS Not Contains .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sort=None, sort_by=None, headers=None, **query_parameters)[source]¶ Alias for get_vn_vlan_mappings_generator
-
create_vn_vlan_mapping
(id=None, is_data=None, is_default_vlan=None, last_update=None, max_value=None, name=None, vn_id=None, vn_name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Create VN-Vlan Mapping.
- Parameters
id (string) – Identifier of the VN-Vlan Mapping, property of the request body.
is_data (boolean) – Flag which indicates whether the Vlan is data or voice type, property of the request body.
is_default_vlan (boolean) – Flag which indicates if the Vlan is default, property of the request body.
last_update (string) – Timestamp for the last update of the VN-Vlan Mapping, property of the request body.
max_value (integer) – Max value, property of the request body.
name (string) – Name of the Vlan, property of the request body.
vn_id (string) – Identifier for the associated Virtual Network which is required unless its name is provided, property of the request body.
vn_name (string) – Name of the associated Virtual Network to be used for identity if id is not provided, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(id=None, is_data=None, is_default_vlan=None, last_update=None, max_value=None, name=None, vn_id=None, vn_name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_vn_vlan_mapping
-
bulk_create_vn_vlan_mappings
(headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Create VN-Vlan Mappings in bulk.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (list) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
bulk_request_create
(headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for bulk_create_vn_vlan_mappings
-
bulk_delete_vn_vlan_mappings
(headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Delete VN-Vlan Mappings in bulk.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (list) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
bulk_request_delete
(headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for bulk_delete_vn_vlan_mappings
-
bulk_update_vn_vlan_mappings
(headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Update VN-Vlan Mappings in bulk.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (list) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
bulk_request_update
(headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for bulk_update_vn_vlan_mappings
-
get_vn_vlan_mapping_by_id
(id, headers=None, **query_parameters)[source]¶ Get VN-Vlan Mapping by id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_vn_vlan_mapping_by_id
-
update_vn_vlan_mapping_by_id
(id, is_data=None, is_default_vlan=None, last_update=None, max_value=None, name=None, vn_id=None, vn_name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Update VN-Vlan Mapping.
- Parameters
id (basestring) – Identifier of the VN-Vlan Mapping, property of the request body.
is_data (boolean) – Flag which indicates whether the Vlan is data or voice type, property of the request body.
is_default_vlan (boolean) – Flag which indicates if the Vlan is default, property of the request body.
last_update (string) – Timestamp for the last update of the VN-Vlan Mapping, property of the request body.
max_value (integer) – Max value, property of the request body.
name (string) – Name of the Vlan, property of the request body.
vn_id (string) – Identifier for the associated Virtual Network which is required unless its name is provided, property of the request body.
vn_name (string) – Name of the associated Virtual Network to be used for identity if id is not provided, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_vn_vlan_mapping_by_id
(id, headers=None, **query_parameters)[source]¶ Delete VN-Vlan Mapping.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
IdentityServicesEngineAPI v3.1.1¶
aci_bindings¶
-
class
AciBindings
[source]¶ Identity Services Engine ACIBindings API (version: 3.1.1).
Wraps the Identity Services Engine ACIBindings API and exposes the API as native Python methods that return native Python objects.
The ACI Bindings API allows clients to retrieve bindings that were sent to Cisco ISE by ACI or received on ACI from Cisco ISE. The binding information will be identical to the information on the ACI bindings page in the Cisco ISE UI. Filtering will be based on one attribute only, such as ip, sgt, vn, psn, learnedFrom, or learnedBy with CONTAINS mode of search.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
3.0
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Example Values
name
String
Yes
Resource Name
id
String
No
Resource UUID value
f9269682-dcaf-11e3-ad0a-5bdcd2d9fd69
description
String
No
ip
String
Yes
Binding IPv4 address. Each binding will be exclusively identified by its IP address and virtual network
10.0.0.1
sgt
String
No
Security Group Tag (SGT) value. The valid range for SGT values is 0-65534
1234
vn
String
Yes
Virtual network. Each binding will be exclusively identified by its IP address and virtual network
vn1234
psn
String
No
Cisco ISE Policy Service node (PSN) IP address
10.86.189.216
learnedFrom
String
Yes
Binding Source
ISE by ACI ACI by ISE
learnedBy
String
Yes
Binding Type
SXP(SXP, 0) STATIC(Static, 1) RADIUS(RADIUS, 2) ACI(ACI, 3)
-
get_aci_bindings
(filter_by=None, filter_value=None, page=None, size=None, sort=None, sort_by=None, headers=None, **query_parameters)[source]¶ This API allows clients to retrieve all the bindings that were sent to Cisco ISE by ACI or received on ACI from Cisco ISE.The binding information will be identical to the information on ACI bindings page in the Cisco ISE UI. Filtering will be based on one attribute only, such as ip/sgt/vn/psn/learnedFrom/learnedBy with CONTAINS mode of search.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sort (basestring) – sort query parameter. sort type asc or desc.
sort_by (basestring) – sortBy query parameter. sort column by which objects needs to be sorted.
filter_by (basestring, list, set, tuple) – filterBy query parameter.
filter_value (basestring, list, set, tuple) – filterValue query parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter_by=None, filter_value=None, page=None, size=None, sort=None, sort_by=None, headers=None, **query_parameters)[source]¶ Alias for get_aci_bindings
-
get_aci_bindings_generator
(filter_by=None, filter_value=None, page=None, size=None, sort=None, sort_by=None, headers=None, **query_parameters)[source]¶ This API allows clients to retrieve all the bindings that were sent to Cisco ISE by ACI or received on ACI from Cisco ISE.The binding information will be identical to the information on ACI bindings page in the Cisco ISE UI. Filtering will be based on one attribute only, such as ip/sgt/vn/psn/learnedFrom/learnedBy with CONTAINS mode of search.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sort (basestring) – sort query parameter. sort type asc or desc.
sort_by (basestring) – sortBy query parameter. sort column by which objects needs to be sorted.
filter_by (basestring, list, set, tuple) – filterBy query parameter.
filter_value (basestring, list, set, tuple) – filterValue query parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter_by=None, filter_value=None, page=None, size=None, sort=None, sort_by=None, headers=None, **query_parameters)[source]¶ Alias for get_aci_bindings_generator
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the Cisco ACI bindings.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
aci_settings¶
-
class
AciSettings
[source]¶ Identity Services Engine ACISettings API (version: 3.1.1).
Wraps the Identity Services Engine ACISettings API and exposes the API as native Python methods that return native Python objects.
ACI Settings API allows the client to get and update the ACI Settings. In addition, testing the ACI Domain Manager connection is also possible using the TestACIConnection.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
3.0
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Default Values
Example Values
name
String
Yes
Resource Name
AciSettings
id
String
No
Resource UUID value
29fb45ab-6a8e-4658-8a28-02521c258178
description
String
No
Aci Settings
enableAci
Boolean
Yes
Enable ACI Integration
false
isAci50
Boolean
Yes
Enable 5.0 ACI Version
false
ipAddressHostName
String
No
ACI Cluster IP Address / Host name
adminName
String
No
ACI Cluster Admin name
adminPassword
String
No
ACI Cluster Admin password
tenantName
String
No
ACI Cluster Tenant name
ISE
l3RouteNetwork
String
No
ACI Cluster L3 Route network name
L3_ROUTE
suffixToEpg
String
No
Name Conversion - EPG suffix
SGT
suffixToSgt
String
No
Name Conversion - SGT suffix
EPG
allSxpDomain
Boolean
No
SXP Propagation to all the SXP domains
false
specificSxpDomain
Boolean
No
SXP Propagation to specific SXP domains
true
specifixSxpDomainList
List
No
Specific SXP domains list
[default]
isAci51
Boolean
Yes
Enable 5.1 ACI Version
false
aciipaddress
String
No
ACI Domain manager Ip Address
aciuserName
String
No
ACI Domain manager Username
acipassword
String
No
ACI Domain manager Password
enableDataPlane
Boolean
No
Enable data plane
false
untaggedPacketIepgName
String
No
Untagged IEPG packets name
untagged
defaultSgtName
String
No
Default SGT name
Unknown
enableElementsLimit
Boolean
No
Enable Elements Limit
false
maxNumIepgFromAci
Integer
No
Max number of IEPGs
1000
maxNumSgtToAci
Integer
No
Max number of SGTs
500
-
get_aci_settings
(headers=None, **query_parameters)[source]¶ This API allows the client to get ACI Settings.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(headers=None, **query_parameters)[source]¶ Alias for get_aci_settings
-
test_aci_connectivity
(headers=None, **query_parameters)[source]¶ This API allows the client to test ACI Domain Manager connection.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_aci_settings_by_id
(id, aci50=None, aci51=None, aciipaddress=None, acipassword=None, aciuser_name=None, admin_name=None, admin_password=None, all_sxp_domain=None, default_sgt_name=None, enable_aci=None, enable_data_plane=None, enable_elements_limit=None, ip_address_host_name=None, l3_route_network=None, max_num_iepg_from_aci=None, max_num_sgt_to_aci=None, specific_sxp_domain=None, specifix_sxp_domain_list=None, suffix_to_epg=None, suffix_to_sgt=None, tenant_name=None, untagged_packet_iepg_name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update ACI settings.
- Parameters
aci50 (boolean) – Enable 5.0 ACI Version, property of the request body.
aci51 (boolean) – Enable 5.1 ACI Version, property of the request body.
aciipaddress (string) – ACI Domain manager Ip Address., property of the request body.
acipassword (string) – ACI Domain manager Password., property of the request body.
aciuser_name (string) – ACI Domain manager Username., property of the request body.
admin_name (string) – ACI Cluster Admin name, property of the request body.
admin_password (string) – ACI Cluster Admin password, property of the request body.
all_sxp_domain (boolean) – allSxpDomain, property of the request body.
default_sgt_name (string) – defaultSgtName, property of the request body.
enable_aci (boolean) – Enable ACI Integration, property of the request body.
enable_data_plane (boolean) – enableDataPlane, property of the request body.
enable_elements_limit (boolean) – enableElementsLimit, property of the request body.
id (basestring) – Resource UUID value, property of the request body.
ip_address_host_name (string) – ACI Cluster IP Address / Host name, property of the request body.
l3_route_network (string) – l3RouteNetwork, property of the request body.
max_num_iepg_from_aci (integer) – maxNumIepgFromAci, property of the request body.
max_num_sgt_to_aci (integer) – maxNumSgtToAci, property of the request body.
specific_sxp_domain (boolean) – specificSxpDomain, property of the request body.
specifix_sxp_domain_list (list) – specifixSxpDomainList, property of the request body (list of strings).
suffix_to_epg (string) – suffixToEpg, property of the request body.
suffix_to_sgt (string) – suffixToSgt, property of the request body.
tenant_name (string) – tenantName, property of the request body.
untagged_packet_iepg_name (string) – untaggedPacketIepgName, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, aci50=None, aci51=None, aciipaddress=None, acipassword=None, aciuser_name=None, admin_name=None, admin_password=None, all_sxp_domain=None, default_sgt_name=None, enable_aci=None, enable_data_plane=None, enable_elements_limit=None, ip_address_host_name=None, l3_route_network=None, max_num_iepg_from_aci=None, max_num_sgt_to_aci=None, specific_sxp_domain=None, specifix_sxp_domain_list=None, suffix_to_epg=None, suffix_to_sgt=None, tenant_name=None, untagged_packet_iepg_name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_aci_settings_by_id
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the Cisco ACI settings.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
anc_endpoint¶
-
class
AncEndpoint
[source]¶ Identity Services Engine ANCEndpoint API (version: 3.1.1).
Wraps the Identity Services Engine ANCEndpoint API and exposes the API as native Python methods that return native Python objects.
Adaptive Network Control (ANC) provides the ability to create network endpoint authorization controls based on ANC policies.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.1
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Example Values
name
String
Yes
Resource Name
id
String
No
Resource UUID
f9269682-dcaf-11e3-ad0a-5bdcd2d9fd69
description
String
No
macAddress
String
Yes
MAC address of the endpoint
00:11:22:33:44:55
policyName
String
Yes
Policy name to be applied to the endpoint
policy1
Supported ANC API transactions per second
On a 5 node Cisco ISE deployment with 60k sessions or on a 9 node Cisco ISE deployment with 200k/500k sessions, 250 transactions per second (TPS) is supported for any ANC API.Supported ANC APIs* applyEndpointByMacAddress * clearEndpointByMacaddress * applyEndpointByIpAddress * applyEndpointPolicy * clearEndpointPolicyDeployment
Number of Sessions
Supported ANC APIs TPS
5 nodes
60k
250
9 nodes
200k
250
5 nodes
500k
250
-
get_anc_endpoint_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get an ANC endpoint by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_anc_endpoint_by_id
-
clear_anc_endpoint
(additional_data=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to clear the required configuration.
- Parameters
additional_data (list) – additionalData, property of the request body (list of objects).
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
clear
(additional_data=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for clear_anc_endpoint
-
get_anc_endpoint
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the ANC endpoints. Filter: [name] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_anc_endpoint
-
get_anc_endpoint_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the ANC endpoints. Filter: [name] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_anc_endpoint_generator
-
apply_anc_endpoint
(additional_data=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to apply the required configuration.
- Parameters
additional_data (list) – additionalData, property of the request body (list of objects).
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
apply
(additional_data=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for apply_anc_endpoint
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the ANC Endpoint.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
bulk_request_for_anc_endpoint
(operation_type=None, resource_media_type=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to submit the bulk request.
- Parameters
operation_type (string) – operationType, property of the request body.
resource_media_type (string) – resourceMediaType, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
bulk_request
(operation_type=None, resource_media_type=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for bulk_request_for_anc_endpoint
-
monitor_bulk_status_anc_endpoint
(bulkid, headers=None, **query_parameters)[source]¶ This API allows the client to monitor the bulk request.
- Parameters
bulkid (basestring) – bulkid path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
monitor_bulk_status
(bulkid, headers=None, **query_parameters)[source]¶ Alias for monitor_bulk_status_anc_endpoint
-
active_directory¶
-
class
ActiveDirectory
[source]¶ Identity Services Engine ActiveDirectory API (version: 3.1.1).
Wraps the Identity Services Engine ActiveDirectory API and exposes the API as native Python methods that return native Python objects.
The Active Directory API allows the user to carry out add, delete, and search operations on the active directory domains through Cisco ISE’s join points. For example, if you want to connect to the domain cisco.com and retrieve the domain groups, you can carry out the following steps which are also available as APIs: Step 1 Create a domain join point in Cisco ISE. In the “domain” parameter use cisco.com.Step 2 Get all defined join points and copy your join point’s ID from the response.Step 3 Join all Cisco ISE nodes to the domain. Use the ID received in the Step 2 in the URL. From this point onwards, you can perform several actions. In each action you should specify the joint point ID in the URL, as retrieved in step 2 in the previous configuration task. For example, you can: • Retrieve the user groups using the join point ID.• Retrieve the groups of a specific domain using the join point ID. The domain parameter can be cisco.com or any of its trusted domains. You can use the get all trusted domains operation to retrieve the list.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
Revision Modification
Revision Modification
Attribute
Description
0
1.0
2.2
Initial Cisco ISE Version
1
1.1
2.4
Support new attributes
advancedSettings
Added ERSActiveDirectoryAdvancedSettings Attribute ‘advancedSettings’
adAttributes
Added ERSActiveDirectoryAttributes Attribute ‘adAttributes’
enableDomainWhiteList
Added Boolean Attribute ‘enableDomainWhiteList’
2
1.2
3.1
Support new attributes under ActiveDirectory AdvancedSettings
enableFailedAuthProtection
Added Boolean Attribute ‘enableFailedAuthProtection’
failedAuthThreshold
Added Integer Attribute ‘failedAuthThreshold’
authProtectionType
Added Enum Attribute ‘authProtectionType’
Resource Definition
Attribute
Type
Required
Description
Default Values
Example Values
name
String
Yes
Resource Name. Maximum 32 characters allowed. Allowed characters are alphanumeric and .-_/ characters
…
Company_users
id
String
No
Resource UUID value
…
af1cd190-7d71-11eb-b02e-ead13cf60dcb
description
String
No
No character restriction
…
Group of Active company users
domain
String
Yes
The AD domain. Alphanumeric, hyphen (-) and dot (.) characters are allowed
…
cisco.com
adScopesNames
String
No
String that contains the names of the scopes that the active directory belongs to. Names are separated by comma. Alphanumeric, underscore (_) characters are allowed
Default_Scope
…
enableDomainWhiteList
Boolean
No
…
true
…
adGroups
List
No
Holds list of AD Groups
…
…
groups
List
No
List of Groups
…
…
name
String
Yes
Required for each group in the group list with no duplication between groups. All characters are allowed except %
…
cisco.com/operators
sid
String
Yes
Cisco ISE uses security identifiers (SIDs) for optimization of group membership evaluation. SIDs are useful for efficiency (speed) when the groups are evaluated. All characters are allowed except %
…
S-1-5-32-548
type
String
No
No character restriction
…
GLOBAL
adAttributes
List
No
Holds list of AD Attributes
…
…
attributes
List
No
List of Attributes
…
…
name
String
Yes
Required for each attribute in the attribute list with no duplication between attributes. All characters are allowed except <%”
…
name1
type
Enum
Yes
Required for each group in the group list. Allowed values: - STRING, - IP, - BOOLEAN, - INT, - OCTET_STRING
STRING
…
internalName
String
Yes
Required for each attribute in the attribute list. All characters are allowed except <%”
…
internalName1
defaultValue
String
Yes
Required for each attribute in the attribute list. Can contain an empty string. All characters are allowed except <%”
…
defaultString
advancedSettings
List
No
…
…
…
rewriteRules
List
No
Identity rewrite is an advanced feature that directs Cisco ISE to manipulate the identity before it is passed to the external Active Directory system. You can create rules to change the identity to a desired format that includes or excludes a domain prefix and/or suffix or other additional markup of your choice
…
…
rowId
Integer
Yes
Required for each rule in the list in serial order
…
0
rewriteMatch
String
Yes
Required for each rule in the list with no duplication between rules. All characters are allowed except %”
…
exampleMatch0
rewriteResult
String
Yes
Required for each rule in the list. All characters are allowed except %”
…
exampleResult0
enableRewrites
Boolean
No
…
false
…
enablePassChange
Boolean
No
…
true
…
enableMachineAuth
Boolean
No
…
true
…
enableMachineAccess
Boolean
No
…
true
…
enableDialinPermissionCheck
Boolean
No
…
false
…
plaintextAuth
Boolean
No
…
false
…
agingTime
Integer
No
Range 1-8760 hours
5
…
enableCallbackForDialinClient
Boolean
No
…
false
…
identityNotInAdBehaviour
Enum
No
Allowed values: - REJECT, - SEARCH_JOINED_FOREST, - SEARCH_ALL
SEARCH_JOINED_FOREST
…
unreachableDomainsBehaviour
Enum
No
Allowed values: - PROCEED, - DROP
PROCEED
…
schema
Enum
No
Allowed values: - ACTIVE_DIRECTORY, - CUSTOMChoose ACTIVE_DIRECTORY schema when the AD attributes defined in AD can be copied to relevant attributes in Cisco ISE. If customization is needed, choose CUSTOM schema. All User info attributes are always set to default value if schema is ACTIVE_DIRECTORY. Values can be changed only for CUSTOM schema
ACTIVE_DIRECTORY
…
firstName
String
No
User info attribute. All characters are allowed except %
givenName
…
department
String
No
User info attribute. All characters are allowed except %
department
…
lastName
String
No
User info attribute. All characters are allowed except %
sn
…
organizationalUnit
String
No
User info attribute. All characters are allowed except %
company
…
jobTitle
String
No
User info attribute. All characters are allowed except %
title
…
locality
String
No
User info attribute. All characters are allowed except %
l
…
email
String
No
User info attribute. All characters are allowed except %
mail
…
stateOrProvince
String
No
User info attribute. All characters are allowed except %
st
…
telephone
String
No
User info attribute. All characters are allowed except %
telephoneNumber
…
country
String
No
User info attribute. All characters are allowed except %
co
…
streetAddress
String
No
User info attribute. All characters are allowed except %
streetAddress
…
enableFailedAuthProtection
Boolean
No
Enable prevent AD account lockout due to too many bad password attempts
false
…
failedAuthThreshold
Integer
No
Number of bad password attempts
5
…
authProtectionType
Enum
No
Enable prevent AD account lockout. Allowed values:- WIRELESS, - WIRED, - BOTH
WIRELESS
…
-
get_active_directory_by_name
(name, headers=None, **query_parameters)[source]¶ This API allows the client to get Active Directory by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_name
(name, headers=None, **query_parameters)[source]¶ Alias for get_active_directory_by_name
-
get_user_groups
(id, additional_data=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to get groups of which a given user is a member.
- Parameters
additional_data (list) – additionalData, property of the request body (list of objects).
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
load_groups_from_domain
(id, ad_attributes=None, ad_scopes_names=None, adgroups=None, advanced_settings=None, description=None, domain=None, enable_domain_white_list=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API loads domain groups configuration from Active Directory into Cisco ISE.
- Parameters
ad_attributes (object) – Holds list of AD Attributes, property of the request body.
ad_scopes_names (string) – String that contains the names of the scopes that the active directory belongs to. Names are separated by comma. Alphanumeric, underscore (_) characters are allowed, property of the request body.
adgroups (object) – Holds list of AD Groups, property of the request body.
advanced_settings (object) – advancedSettings, property of the request body.
description (string) – No character restriction, property of the request body.
domain (string) – The AD domain. Alphanumeric, hyphen (-) and dot (.) characters are allowed, property of the request body.
enable_domain_white_list (boolean) – enableDomainWhiteList, property of the request body.
id (basestring) – Resource UUID value, property of the request body.
name (string) – Resource Name. Maximum 32 characters allowed. Allowed characters are alphanumeric and .-_/characters, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
leave_domain
(id, additional_data=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API makes a Cisco ISE node to leave an Active Directory domain.
- Parameters
additional_data (list) – additionalData, property of the request body (list of objects).
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
is_user_member_of_groups
(id, additional_data=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API verifies if the user is a member of the given groups.
- Parameters
additional_data (list) – additionalData, property of the request body (list of objects).
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_trusted_domains
(id, headers=None, **query_parameters)[source]¶ This API gets the list of domains that are accessible through the given join point via trust relationships.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
join_domain_with_all_nodes
(id, additional_data=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API joins all Cisco ISE Nodes to an Active Directory domain.
- Parameters
additional_data (list) – additionalData, property of the request body (list of objects).
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
leave_domain_with_all_nodes
(id, additional_data=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API joins makes all Cisco ISE nodes leave an Active Directory domain.
- Parameters
additional_data (list) – additionalData, property of the request body (list of objects).
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_groups_by_domain
(id, additional_data=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API lists the groups of the given domain.
- Parameters
additional_data (list) – additionalData, property of the request body (list of objects).
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_active_directory_by_id
(id, headers=None, **query_parameters)[source]¶ This API fetchs the join point details by ID. The ID can be retrieved with the Get All operation.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_active_directory_by_id
-
delete_active_directory_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes an AD join point from Cisco ISE.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_active_directory_by_id
-
join_domain
(id, additional_data=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API joins a Cisco ISE node to an Active Directory domain.
- Parameters
additional_data (list) – additionalData, property of the request body (list of objects).
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_active_directory
(page=None, size=None, headers=None, **query_parameters)[source]¶ This API lists all the join points for Active Directory domains in Cisco ISE.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_active_directory
-
get_active_directory_generator
(page=None, size=None, headers=None, **query_parameters)[source]¶ This API lists all the join points for Active Directory domains in Cisco ISE.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_active_directory_generator
-
create_active_directory
(ad_attributes=None, ad_scopes_names=None, adgroups=None, advanced_settings=None, description=None, domain=None, enable_domain_white_list=None, id=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates an AD join point in Cisco ISE.
- Parameters
ad_attributes (object) – Holds list of AD Attributes, property of the request body.
ad_scopes_names (string) – String that contains the names of the scopes that the active directory belongs to. Names are separated by comma. Alphanumeric, underscore (_) characters are allowed, property of the request body.
adgroups (object) – Holds list of AD Groups, property of the request body.
advanced_settings (object) – advancedSettings, property of the request body.
description (string) – No character restriction, property of the request body.
domain (string) – The AD domain. Alphanumeric, hyphen (-) and dot (.) characters are allowed, property of the request body.
enable_domain_white_list (boolean) – enableDomainWhiteList, property of the request body.
id (string) – Resource UUID value, property of the request body.
name (string) – Resource Name. Maximum 32 characters allowed. Allowed characters are alphanumeric and .-_/characters, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(ad_attributes=None, ad_scopes_names=None, adgroups=None, advanced_settings=None, description=None, domain=None, enable_domain_white_list=None, id=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_active_directory
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the active directory.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
admin_user¶
-
class
AdminUser
[source]¶ Identity Services Engine AdminUser API (version: 3.1.1).
Wraps the Identity Services Engine AdminUser API and exposes the API as native Python methods that return native Python objects.
The Admin User API allows to retrieve information related to admin users configured on Cisco ISE.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
1.2
Initial Cisco ISE Version
1
1.1
2.0
Cisco ISE Release 2.3 Admin User
Resource Definition
Attribute
Type
Required
Description
Example Values
Default Value
name
String
Yes
Resource Name
id
String
Yes
Resource UUID
f9269682-dcaf-11e3-ad0a-5bdcd2d9fd69
description
String
No
changePassword
Boolean
Yes
true
true
email
String
No
includeSystemAlarmsInEmail
Boolean
No
false
inactiveAccountNeverDisabled
Boolean
No
true
enabled
Boolean
Yes
false
external
Boolean
No
true
customAttributes
String
No
Key Value Map
{“MyCustomAttribute” : “Value1”}
firstName
String
No
adminGroups
String
No
Admin Group Names
Super Admin
lastName
String
No
password
String
No
The password field doesn’t show the actual password configured. It is hidden with the asterisk (*) symbol
-
get_admin_user_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get an admin user by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_admin_user_by_id
-
get_admin_users
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the admin users. Filter: [firstName, lastName, adminGroups, name, description, inactiveAccountNeverDisabled, includeSystemAlarmsInEmail, email, enabled] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_admin_users
-
get_admin_users_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the admin users. Filter: [firstName, lastName, adminGroups, name, description, inactiveAccountNeverDisabled, includeSystemAlarmsInEmail, email, enabled] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_admin_users_generator
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the admin user.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
allowed_protocols¶
-
class
AllowedProtocols
[source]¶ Identity Services Engine AllowedProtocols API (version: 3.1.1).
Wraps the Identity Services Engine AllowedProtocols API and exposes the API as native Python methods that return native Python objects.
Allowed Protocols API allows the client to add, delete, update, search and perform actions on allowed protocols.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
Revision Modification
Revision Modification
Attribute
Description
0
1.0
2.3
Initial Cisco ISE Version
1
1.1
2.7
Added support for TEAP
preferredEapProtocol
Added value ‘TEAP’ to enum attribute preferredEapProtocol
allowTeap
Added boolean attribute allowTeap
allowTeapEapMsChapV2
Added boolean attribute allowTeapEapMsChapV2
allowTeapEapMsChapV2PwdChange
Added boolean attribute allowTeap
allowTeapEapMsChapV2PwdChangeRetries
Added int attribute allowTeapEapMsChapV2PwdChangeRetries
allowTeapEapTls
Added boolean attribute allowTeapEapTls
Resource Definition
Attribute
Type
Required
Description
Example Values
name
String
Yes
Resource Name
Default Device Admin
id
String
No
Resource UUID, Mandatory for update
926901b0-8c01-11e6-996c-525400b48521
description
String
No
Default Allowed Protocol Service Device Admin
processHostLookup
Boolean
Yes
true
allowPapAscii
Boolean
No
true
allowChap
Boolean
Yes
false
allowMsChapV1
Boolean
Yes
false
allowMsChapV2
Boolean
Yes
false
allowEapMd5
Boolean
Yes
true
allowLeap
Boolean
Yes
false
allowEapTls
Boolean
Yes
true
allowEapTtls
Boolean
Yes
true
allowEapFast
Boolean
Yes
true
allowPeap
Boolean
Yes
true
allowTeap
Boolean
Yes
true
allowPreferredEapProtocol
Boolean
Yes
true
eapTlsLBit
Boolean
Yes
false
allowWeakCiphersForEap
Boolean
Yes
false
requireMessageAuth
Boolean
Yes
false
preferredEapProtocol
Enum
No
The preferredEapProtocol is required only if allowPreferredEapProtocol is true, otherwise it must be ignored.
PEAP
eapTls
List
No
The eapTls is required only if allowEapTls is true, otherwise it must be ignored. The object eapTls contains the settings for EAP TLS protocol
allowEapTlsAuthOfExpiredCerts
Boolean
Yes
false
eapTlsEnableStatelessSessionResume
Boolean
Yes
false
eapTlsSessionTicketTtl
Integer
No
Time to live. The eapTlsSessionTicketTtl is required only if eapTlsEnableStatelessSessionResume is true, otherwise it must be ignored
1
eapTlsSessionTicketTtlUnits
Enum
No
Time to live time units. The eapTlsSessionTicketTtlUnits is required only if eapTlsEnableStatelessSessionResume is true, otherwise it must be ignored.
SECONDS
eapTlsSessionTicketPrecentage
Integer
No
The eapTlsSessionTicketPrecentage is required only if eapTlsEnableStatelessSessionResume is true, otherwise it must be ignored
1
peap
List
No
The peap is required only if allowPeap is true, otherwise it must be ignored. The object peap contains the settings for PEAP protocol
allowPeapEapMsChapV2
Boolean
Yes
true
allowPeapEapMsChapV2PwdChange
Boolean
No
The allowPeapEapMsChapV2PwdChange is required only if allowPeapEapMsChapV2 is true, otherwise it must be ignored
true
allowPeapEapMsChapV2PwdChangeRetries
Integer
No
The allowPeapEapMsChapV2PwdChangeRetries is required only if allowPeapEapMsChapV2 is true, otherwise it must be ignored. Valid range is 0-3
1
allowPeapEapGtc
Boolean
Yes
false
allowPeapEapGtcPwdChange
Boolean
No
The allowPeapEapGtcPwdChange is required only if allowPeapEapGtc is true, otherwise it must be ignored
false
allowPeapEapGtcPwdChangeRetries
Integer
No
The allowPeapEapGtcPwdChangeRetries is required only if allowPeapEapGtc is true, otherwise it must be ignored. Valid range is 0-3
1
allowPeapEapTls
Boolean
Yes
true
allowPeapEapTlsAuthOfExpiredCerts
Boolean
No
The allowPeapEapTlsAuthOfExpiredCerts is required only if allowPeapEapTls is true, otherwise it must be ignored
false
requireCryptobinding
Boolean
Yes
false
allowPeapV0
Boolean
Yes
false
eapTtls
List
No
The eapTtls is required only if allowEapTtls is true, otherwise it must be ignored. The object eapTtls contains the settings for EAP TTLS protocol
eapTtlsPapAscii
Boolean
Yes
true
eapTtlsChap
Boolean
Yes
true
eapTtlsMsChapV1
Boolean
Yes
true
eapTtlsMsChapV2
Boolean
Yes
true
eapTtlsEapMd5
Boolean
Yes
true
eapTtlsEapMsChapV2
Boolean
Yes
true
eapTtlsEapMsChapV2PwdChange
Boolean
No
The eapTtlsEapMsChapV2PwdChange is required only if eapTtlsEapMsChapV2 is true, otherwise it must be ignored
true
eapTtlsEapMsChapV2PwdChangeRetries
Integer
No
The eapTtlsEapMsChapV2PwdChangeRetries is required only if eapTtlsEapMsChapV2 is true, otherwise it must be ignored. Valid range is 0-3
1
eapFast
List
No
The eapFast is required only if allowEapFast is true, otherwise it must be ignored. The object eapFast contains the settings for EAP FAST protocol
allowEapFastEapMsChapV2
Boolean
Yes
true
allowEapFastEapMsChapV2PwdChange
Boolean
No
The allowEapFastEapMsChapV2PwdChange is required only if allowEapFastEapMsChapV2 is true, otherwise it must be ignored
true
allowEapFastEapMsChapV2PwdChangeRetries
Integer
No
The allowEapFastEapMsChapV2PwdChangeRetries is required only if eapTtlsEapMsChapV2 is true, otherwise it must be ignored. Valid range is 0-3
1
allowEapFastEapGtc
Boolean
Yes
true
allowEapFastEapGtcPwdChange
Boolean
No
The allowEapFastEapGtcPwdChange is required only if allowEapFastEapGtc is true, otherwise it must be ignored
true
allowEapFastEapGtcPwdChangeRetries
Integer
No
The allowEapFastEapGtcPwdChangeRetries is required only if allowEapFastEapGtc is true, otherwise it must be ignored. Valid range is 0-3
1
allowEapFastEapTls
Boolean
Yes
true
allowEapFastEapTlsAuthOfExpiredCerts
Boolean
No
The allowEapFastEapTlsAuthOfExpiredCerts is required only if allowEapFastEapTls is true, otherwise it must be ignored
false
eapFastEnableEAPChaining
Boolean
Yes
false
eapFastUsePacs
Boolean
Yes
true
eapFastUsePacsTunnelPacTtl
Integer
No
The eapFastUsePacsTunnelPacTtl is required only if eapFastUsePacs is true, otherwise it must be ignored
7776000
eapFastUsePacsTunnelPacTtlUnits
Enum
No
The eapFastUsePacsTunnelPacTtlUnits is required only if eapFastUsePacs is true, otherwise it must be ignored.
SECONDS
eapFastUsePacsUseProactivePacUpdatePrecentage
Integer
No
The eapFastUsePacsUseProactivePacUpdatePrecentage is required only if eapFastUsePacs is true, otherwise it must be ignored
10
eapFastUsePacsAllowAnonymProvisioning
Boolean
No
The eapFastUsePacsAllowAnonymProvisioning is required only if eapFastUsePacs is true, otherwise it must be ignored
false
eapFastUsePacsAllowAuthenProvisioning
Boolean
No
The eapFastUsePacsAllowAuthenProvisioning is required only if eapFastUsePacs is true, otherwise it must be ignored
false
eapFastUsePacsReturnAccessAccept
AfterAuthenticatedProvisioning
Boolean
No
The eapFastUsePacsReturnAccessAcceptAfterAuthenticatedProvisioning is required only if eapFastUsePacsAllowAuthenProvisioning is true, otherwise it must be ignored
false
eapFastUsePacsAcceptClientCert
Boolean
No
The eapFastUsePacsAcceptClientCert is required only if eapFastUsePacsAllowAuthenProvisioning is true, otherwise it must be ignored
false
eapFastUsePacsAllowMachineAuthentication
Boolean
No
false
eapFastUsePacsMachinePacTtl
Integer
No
The eapFastUsePacsMachinePacTtl is required only if eapFastUsePacsAllowMachineAuthentication is true, otherwise it must be ignored
1
eapFastUsePacsMachinePacTtlUnits
Enum
No
The eapFastUsePacsMachinePacTtlUnits is required only if eapFastUsePacsAllowMachineAuthentication is true, otherwise it must be ignored.
SECONDS
eapFastUsePacsStatelessSessionResume
Boolean
No
The eapFastUsePacsStatelessSessionResume is required only if eapFastUsePacs is true, otherwise it must be ignored
false
eapFastUsePacsAuthorizationPacTtl
Integer
No
The eapFastUsePacsAuthorizationPacTtl is required only if eapFastUsePacsStatelessSessionResume is true, otherwise it must be ignored
1
eapFastUsePacsAuthorizationPacTtlUnits
Enum
No
The eapFastUsePacsAuthorizationPacTtlUnits is required only if eapFastUsePacsStatelessSessionResume is true, otherwise it must be ignored.
SECONDS
eapFastDontUsePacsAcceptClientCert
Boolean
No
The eapFastDontUsePacsAcceptClientCert is required only if eapFastUsePacs is FALSE, otherwise it must be ignored
false
eapFastDontUsePacsAllowMachineAuthentication
Boolean
No
The eapFastDontUsePacsAllowMachineAuthentication is required only if eapFastUsePacs is FALSE, otherwise it must be ignored
false
teap
List
No
The teap is required only if allowTeap is true, otherwise it must be ignored. The object teap contains the settings for TEAP protocol
allowTeapEapMsChapV2
Boolean
Yes
true
allowTeapEapMsChapV2PwdChange
Boolean
No
The allowTeapEapMsChapV2PwdChange is required only if allowTeapEapMsChapV2 is true, otherwise it must be ignored
true
allowTeapEapMsChapV2PwdChangeRetries
Integer
No
The allowTeapEapMsChapV2PwdChangeRetries is required only if allowTeapEapMsChapV2 is true, otherwise it must be ignored. Valid range is 0-3
3
allowTeapEapTls
Boolean
Yes
true
allowTeapEapTlsAuthOfExpiredCerts
Boolean
No
The allowTeapEapTlsAuthOfExpiredCerts is required only if allowTeapEapTls is true, otherwise it must be ignored
false
acceptClientCertDuringTunnelEst
Boolean
Yes
true
enableEapChaining
Boolean
Yes
false
allowDowngradeMsk
Boolean
Yes
false
-
get_allowed_protocol_by_name
(name, headers=None, **query_parameters)[source]¶ This API allows the client to get an allowed protocol by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_name
(name, headers=None, **query_parameters)[source]¶ Alias for get_allowed_protocol_by_name
-
get_allowed_protocol_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get an allowed protocol by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_allowed_protocol_by_id
-
update_allowed_protocol_by_id
(id, allow_chap=None, allow_eap_fast=None, allow_eap_md5=None, allow_eap_tls=None, allow_eap_ttls=None, allow_leap=None, allow_ms_chap_v1=None, allow_ms_chap_v2=None, allow_pap_ascii=None, allow_peap=None, allow_preferred_eap_protocol=None, allow_teap=None, allow_weak_ciphers_for_eap=None, description=None, eap_fast=None, eap_tls=None, eap_tls_l_bit=None, eap_ttls=None, name=None, peap=None, preferred_eap_protocol=None, process_host_lookup=None, require_message_auth=None, teap=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update an allowed protocol.
- Parameters
allow_chap (boolean) – allowChap, property of the request body.
allow_eap_fast (boolean) – allowEapFast, property of the request body.
allow_eap_md5 (boolean) – allowEapMd5, property of the request body.
allow_eap_tls (boolean) – allowEapTls, property of the request body.
allow_eap_ttls (boolean) – allowEapTtls, property of the request body.
allow_leap (boolean) – allowLeap, property of the request body.
allow_ms_chap_v1 (boolean) – allowMsChapV1, property of the request body.
allow_ms_chap_v2 (boolean) – allowMsChapV2, property of the request body.
allow_pap_ascii (boolean) – allowPapAscii, property of the request body.
allow_peap (boolean) – allowPeap, property of the request body.
allow_preferred_eap_protocol (boolean) – allowPreferredEapProtocol, property of the request body.
allow_teap (boolean) – allowTeap, property of the request body.
allow_weak_ciphers_for_eap (boolean) – allowWeakCiphersForEap, property of the request body.
description (string) – description, property of the request body.
eap_fast (object) – The eapFast is required only if allowEapFast is true, otherwise it must be ignored. The object eapFast contains the settings for EAP FAST protocol, property of the request body.
eap_tls (object) – The eapTls is required only if allowEapTls is true, otherwise it must be ignored. The object eapTls contains the settings for EAP TLS protocol, property of the request body.
eap_tls_l_bit (boolean) – eapTlsLBit, property of the request body.
eap_ttls (object) – The eapTtls is required only if allowEapTtls is true, otherwise it must be ignored. The object eapTtls contains the settings for EAP TTLS protocol, property of the request body.
id (basestring) – Resource UUID, Mandatory for update, property of the request body.
name (string) – Resource Name, property of the request body.
peap (object) – peap, property of the request body.
preferred_eap_protocol (string) – The preferredEapProtocol is required only if allowPreferredEapProtocol is true, otherwise it must be ignored. Allowed Values: EAP_FAST, PEAP, LEAP, EAP_MD5, EAP_TLS, EAP_TTLS, TEAP, property of the request body.
process_host_lookup (boolean) – processHostLookup, property of the request body.
require_message_auth (boolean) – requireMessageAuth, property of the request body.
teap (object) – The teap is required only if allowTeap is true, otherwise it must be ignored. The object teap contains the settings for TEAP protocol, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, allow_chap=None, allow_eap_fast=None, allow_eap_md5=None, allow_eap_tls=None, allow_eap_ttls=None, allow_leap=None, allow_ms_chap_v1=None, allow_ms_chap_v2=None, allow_pap_ascii=None, allow_peap=None, allow_preferred_eap_protocol=None, allow_teap=None, allow_weak_ciphers_for_eap=None, description=None, eap_fast=None, eap_tls=None, eap_tls_l_bit=None, eap_ttls=None, name=None, peap=None, preferred_eap_protocol=None, process_host_lookup=None, require_message_auth=None, teap=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_allowed_protocol_by_id
-
delete_allowed_protocol_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes an allowed protocol.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_allowed_protocol_by_id
-
get_allowed_protocols
(page=None, size=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the allowed protocols.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_allowed_protocols
-
get_allowed_protocols_generator
(page=None, size=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the allowed protocols.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_allowed_protocols_generator
-
create_allowed_protocol
(allow_chap=None, allow_eap_fast=None, allow_eap_md5=None, allow_eap_tls=None, allow_eap_ttls=None, allow_leap=None, allow_ms_chap_v1=None, allow_ms_chap_v2=None, allow_pap_ascii=None, allow_peap=None, allow_preferred_eap_protocol=None, allow_teap=None, allow_weak_ciphers_for_eap=None, description=None, eap_fast=None, eap_tls=None, eap_tls_l_bit=None, eap_ttls=None, name=None, peap=None, preferred_eap_protocol=None, process_host_lookup=None, require_message_auth=None, teap=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates an allowed protocol.
- Parameters
allow_chap (boolean) – allowChap, property of the request body.
allow_eap_fast (boolean) – allowEapFast, property of the request body.
allow_eap_md5 (boolean) – allowEapMd5, property of the request body.
allow_eap_tls (boolean) – allowEapTls, property of the request body.
allow_eap_ttls (boolean) – allowEapTtls, property of the request body.
allow_leap (boolean) – allowLeap, property of the request body.
allow_ms_chap_v1 (boolean) – allowMsChapV1, property of the request body.
allow_ms_chap_v2 (boolean) – allowMsChapV2, property of the request body.
allow_pap_ascii (boolean) – allowPapAscii, property of the request body.
allow_peap (boolean) – allowPeap, property of the request body.
allow_preferred_eap_protocol (boolean) – allowPreferredEapProtocol, property of the request body.
allow_teap (boolean) – allowTeap, property of the request body.
allow_weak_ciphers_for_eap (boolean) – allowWeakCiphersForEap, property of the request body.
description (string) – description, property of the request body.
eap_fast (object) – The eapFast is required only if allowEapFast is true, otherwise it must be ignored. The object eapFast contains the settings for EAP FAST protocol, property of the request body.
eap_tls (object) – The eapTls is required only if allowEapTls is true, otherwise it must be ignored. The object eapTls contains the settings for EAP TLS protocol, property of the request body.
eap_tls_l_bit (boolean) – eapTlsLBit, property of the request body.
eap_ttls (object) – The eapTtls is required only if allowEapTtls is true, otherwise it must be ignored. The object eapTtls contains the settings for EAP TTLS protocol, property of the request body.
name (string) – Resource Name, property of the request body.
peap (object) – peap, property of the request body.
preferred_eap_protocol (string) – The preferredEapProtocol is required only if allowPreferredEapProtocol is true, otherwise it must be ignored. Allowed Values: EAP_FAST, PEAP, LEAP, EAP_MD5, EAP_TLS, EAP_TTLS, TEAP, property of the request body.
process_host_lookup (boolean) – processHostLookup, property of the request body.
require_message_auth (boolean) – requireMessageAuth, property of the request body.
teap (object) – The teap is required only if allowTeap is true, otherwise it must be ignored. The object teap contains the settings for TEAP protocol, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(allow_chap=None, allow_eap_fast=None, allow_eap_md5=None, allow_eap_tls=None, allow_eap_ttls=None, allow_leap=None, allow_ms_chap_v1=None, allow_ms_chap_v2=None, allow_pap_ascii=None, allow_peap=None, allow_preferred_eap_protocol=None, allow_teap=None, allow_weak_ciphers_for_eap=None, description=None, eap_fast=None, eap_tls=None, eap_tls_l_bit=None, eap_ttls=None, name=None, peap=None, preferred_eap_protocol=None, process_host_lookup=None, require_message_auth=None, teap=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_allowed_protocol
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the allowed protocols.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
anc_policy¶
-
class
AncPolicy
[source]¶ Identity Services Engine AncPolicy API (version: 3.1.1).
Wraps the Identity Services Engine AncPolicy API and exposes the API as native Python methods that return native Python objects.
Adaptive Network Control (ANC) provides the ability to create network endpoint authorization controls based on ANC policies.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.1
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Example Values
name
String
Yes
Resource Name
id
String
No
Resource ID
test
description
String
No
action
Enum
Yes
QUARANTINE: Allows you to use Exception policies (authorization policies) to limit or deny an endpoint access to the network.
PORTBOUNCE: Resets the port on the network device to which the endpoint is connected
SHUTDOWN : Shuts down the port on the network device to which the endpoint is connected
RE_AUTHENTICATE: Re-authenticates the session from the endpoint
-
get_anc_policy_by_name
(name, headers=None, **query_parameters)[source]¶ This API allows the client to get an ANC policy by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_name
(name, headers=None, **query_parameters)[source]¶ Alias for get_anc_policy_by_name
-
get_anc_policy_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get an ANC policy by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_anc_policy_by_id
-
update_anc_policy_by_id
(id, actions=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update an ANC policy.
- Parameters
actions (list) – QUARANTINE: Allows you to use Exception policies (authorization policies) to limit or deny an endpoint access to the network. PORTBOUNCE: Resets the port on the network device to which the endpoint is connected. SHUTDOWN : Shuts down the port on the network device to which the endpoint is connected. RE_AUTHENTICATE: Re-authenticates the session from the endpoint., property of the request body (list of strings. Available values are ‘QUARANTINE’, ‘PORTBOUNCE’, ‘SHUTDOWN’ and ‘RE_AUTHENTICATE’).
id (basestring) – id, property of the request body.
name (string) – name, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, actions=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_anc_policy_by_id
-
delete_anc_policy_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to delete an ANC policy.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_anc_policy_by_id
-
get_anc_policy
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the ANC policies. Filter: [name] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_anc_policy
-
get_anc_policy_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the ANC policies. Filter: [name] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_anc_policy_generator
-
create_anc_policy
(actions=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to create an ANC policy.
- Parameters
actions (list) – QUARANTINE: Allows you to use Exception policies (authorization policies) to limit or deny an endpoint access to the network. PORTBOUNCE: Resets the port on the network device to which the endpoint is connected. SHUTDOWN : Shuts down the port on the network device to which the endpoint is connected. RE_AUTHENTICATE: Re-authenticates the session from the endpoint., property of the request body (list of strings. Available values are ‘QUARANTINE’, ‘PORTBOUNCE’, ‘SHUTDOWN’ and ‘RE_AUTHENTICATE’).
name (string) – name, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(actions=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_anc_policy
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the ANC policy.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
bulk_request_for_anc_policy
(operation_type=None, resource_media_type=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to submit the bulk request.
- Parameters
operation_type (string) – operationType, property of the request body.
resource_media_type (string) – resourceMediaType, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
bulk_request
(operation_type=None, resource_media_type=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for bulk_request_for_anc_policy
-
monitor_bulk_status_anc_policy
(bulkid, headers=None, **query_parameters)[source]¶ This API allows the client to monitor the bulk request.
- Parameters
bulkid (basestring) – bulkid path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
monitor_bulk_status
(bulkid, headers=None, **query_parameters)[source]¶ Alias for monitor_bulk_status_anc_policy
byod_portal¶
-
class
ByodPortal
[source]¶ Identity Services Engine BYODPortal API (version: 3.1.1).
Wraps the Identity Services Engine BYODPortal API and exposes the API as native Python methods that return native Python objects.
BYOD Portal API provides the ability to Create, Read, Update, Delete and Search BYOD portals.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.2
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Default Values
Example Values
name
String
Yes
Resource Name
BYOD Portal (default)
id
String
No
Resource UUID, mandatory for update
9a9b910c-54d3-44a4-a3c3-dd007c171599
description
String
No
Default portal and user experience used when employees register a personal device on the network
portalTestUrl
String
No
URL to bring up a test page for this portal
https://{ise-ip}:8443/portal/PortalSetup.action?portal=9a9b910c-54d3-44a4-a3c3-dd007c171599
portalType
Enum
Yes
Allowed values: BYOD, HOTSPOTGUEST, MYDEVICE, SELFREGGUEST, SPONSOR, SPONSOREDGUEST
BYOD
settings
List
No
Defines all of the settings groups available for a BYOD
portalSettings
List
No
The port, interface, certificate, and other basic settings of a portal
httpsPort
Integer
Yes
The port number that the allowed interfaces will listen on. Range from 8000 to 8999
8443
allowedInterfaces
Enum
Yes
Interfaces that the portal will be reachable on. Allowed values: eth0, eth1, eth2, eth3, eth4, eth5, bond0, bond1, bond2
[ “eth0”, “bond0” ]
certificateGroupTag
String
Yes
Logical name of the x.509 server certificate that will be used for the portal
Default Portal Certificate Group
endpointIdentityGroup
String
Yes
Unique Id of the endpoint identity group where user’s devices will be added. Used only in Hotspot Portal
displayLang
Enum
No
Allowed values: USEBROWSERLOCALE, ALWAYSUSE
USEBROWSERLOCALE
fallbackLanguage
String
No
Used when displayLang = USEBROWSERLOCALE
English
alwaysUsedLanguage
String
No
Used when displayLang = ALWAYSUSE
English
byodSettings
List
No
Configuration of BYOD Device Welcome, Registration and Success steps
byodWelcomeSettings
List
No
Configuration of BYOD endpoint welcome step configuration
enableBYOD
Boolean
No
true
enableGuestAccess
Boolean
No
false
requireMDM
Boolean
No
false
includeAup
Boolean
No
true
aupDisplay
Enum
No
How the AUP should be displayed, either on page or as a link. Only valid if includeAup = true. Allowed values: ONPAGE, ASLINK
ONPAGE
requireAupAcceptance
Boolean
No
false
requireScrolling
Boolean
No
Require BYOD devices to scroll down to the bottom of the AUP, Only valid if includeAup = true
false
byodRegistrationSettings
List
No
Configuration of BYOD endpoint Registration step configuration
showDeviceID
Boolean
No
Display Device ID field during registration
true
endPointIdentityGroupId
String
No
Identity group id for which endpoint belongs
aa13bb40-8bff-11e6-996c-525400b48521
byodRegistrationSuccessSettings
List
No
Configuration of BYOD endpoint Registration Success step configuration
successRedirect
Enum
No
After an Authentication Success where should device be redirected.
AUTHSUCCESSPAGE
redirectUrl
String
No
Target URL for redirection, used when successRedirect = URL
Redirect URL
supportInfoSettings
List
No
Configuration of BYOD endpoint welcome step configuration
includeSupportInfoPage
Boolean
No
false
includeMacAddr
Boolean
No
false
includeIpAddress
Boolean
No
false
includeBrowserUserAgent
Boolean
No
false
includePolicyServer
Boolean
No
false
includeFailureCode
Boolean
No
false
emptyFieldDisplay
Enum
No
Specifies how empty fields are handled on the Support Information Page.
HIDE
defaultEmptyFieldValue
String
No
The default value displayed for an empty field Only valid when emptyFieldDisplay = DISPLAYWITHDEFAULTVALUE
customizations
List
No
Defines all of the Portal Customizations available for a BYOD
portalTheme
List
No
Defines the configuration for portal theme
id
String
No
The unique internal identifier of the portal theme
9eb421c0-8c01-11e6-996c-525400b48521
name
String
Yes
The system- or user-assigned name of the portal theme
Default Blue theme
themeData
String
No
A CSS file, represented as a Base64-encoded byte array
Base 64 encoded string of Theme CSS file
portalTweakSettings
List
No
The Tweak Settings are a customization of the Portal Theme that has been selected for the portal. When the Portal Theme selection is changed, the Tweak Settings are overwritten to match the values in the theme. The Tweak Settings can subsequently be changed by the user
bannerColor
String
No
Hex value of color
#0000FF
bannerTextColor
String
No
Banner Text color code from GUI
pageBackgroundColor
String
No
Color code from GUI
pageLabelAndTextColor
String
No
Label and Text color from GUI
language
List
No
This property is supported only for Read operation and it allows to show the customizations in English. Other languages are not supported
viewLanguage
String
No
English
globalCustomizations
List
No
Represent the portal Global customizations
bannerTitle
String
No
BYOD Portal
contactText
String
No
Contact Support
footerElement
String
No
Footer Element
mobileLogoImage
Image
No
data
String
No
Represented as base 64 encoded string of the image byte array
base 64 encoded value of image
desktopLogoImage
Image
No
data
String
No
Represented as base 64 encoded string of the image byte array
base 64 encoded value of image
bannerImage
Image
No
data
String
No
Represented as base 64 encoded string of the image byte array
base 64 encoded value of image
backgroundImage
Image
No
data
String
No
Represented as base 64 encoded string of the image byte array
base 64 encoded value of image
pageCustomizations
List
No
Represent the entire page customization as a giant dictionary
data
List
No
The Dictionary will be exposed here as key value pair
key
String
Yes
ui_contact_ip_address_label
value
String
Yes
SVAgYWRkcmVzczo=
-
get_byod_portal_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get a BYOD portal by ID.
- Parameters
id (basestring) – id path parameter. Portal id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_byod_portal_by_id
-
update_byod_portal_by_id
(id, customizations=None, description=None, name=None, portal_test_url=None, portal_type=None, settings=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update a BYOD portal by ID.
- Parameters
customizations (object) – Defines all of the Portal Customizations available for a BYOD, property of the request body.
description (string) – description, property of the request body.
id (basestring) – Resource UUID, mandatory for update, property of the request body.
name (string) – Resource Name, property of the request body.
portal_test_url (string) – URL to bring up a test page for this portal, property of the request body.
portal_type (string) – Allowed values: BYOD, HOTSPOTGUEST, MYDEVICE, SELFREGGUEST, SPONSOR, SPONSOREDGUEST, property of the request body.
settings (object) – Defines all of the settings groups available for a BYOD, property of the request body.
id – id path parameter. Portal id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, customizations=None, description=None, name=None, portal_test_url=None, portal_type=None, settings=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_byod_portal_by_id
-
delete_byod_portal_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes a BYOD portal by ID.
- Parameters
id (basestring) – id path parameter. Portal id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_byod_portal_by_id
-
get_byod_portal
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the BYOD portals. Filter: [name, description] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_byod_portal
-
get_byod_portal_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the BYOD portals. Filter: [name, description] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_byod_portal_generator
-
create_byod_portal
(customizations=None, description=None, id=None, name=None, portal_test_url=None, portal_type=None, settings=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates a BYOD portal.
- Parameters
customizations (object) – Defines all of the Portal Customizations available for a BYOD, property of the request body.
description (string) – description, property of the request body.
id (string) – Resource UUID, mandatory for update, property of the request body.
name (string) – Resource Name, property of the request body.
portal_test_url (string) – URL to bring up a test page for this portal, property of the request body.
portal_type (string) – Allowed values: BYOD, HOTSPOTGUEST, MYDEVICE, SELFREGGUEST, SPONSOR, SPONSOREDGUEST, property of the request body.
settings (object) – Defines all of the settings groups available for a BYOD, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(customizations=None, description=None, id=None, name=None, portal_test_url=None, portal_type=None, settings=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_byod_portal
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the BYOD portal.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
backup_and_restore¶
-
class
BackupAndRestore
[source]¶ Identity Services Engine Backup And Restore API (version: 3.1.1).
Wraps the Identity Services Engine Backup And Restore API and exposes the API as native Python methods that return native Python objects.
-
config_backup
(backup_encryption_key=None, backup_name=None, repository_name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Triggers on demand configuration backup on the ISE node. The API returns the task ID. Use the Task Service status API to get the status of the backup job.
- Parameters
backup_encryption_key (string) – The encyption key for the backed up file. Encryption key must satisfy the following criteria Contains at least one uppercase letter [A-Z], Contains at least one lowercase letter [a-z], Contains at least one digit [0-9], Contain only [A-Z][a-z][0-9]_#, Has at least 8 characters, Has not more than 15 characters, Must not contain ‘CcIiSsCco’, Must not begin with, property of the request body.
backup_name (string) – The backup file will get saved with this name., property of the request body.
repository_name (string) – Name of the configured repository where the generated backup file will get copied., property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
config
(backup_encryption_key=None, backup_name=None, repository_name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for config_backup
-
cancel_backup
(headers=None, **query_parameters)[source]¶ Cancels the backup job running on the node.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
cancel
(headers=None, **query_parameters)[source]¶ Alias for cancel_backup
-
get_last_config_backup_status
(headers=None, **query_parameters)[source]¶ Gives the last backup status.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_last_status
(headers=None, **query_parameters)[source]¶ Alias for get_last_config_backup_status
-
restore_config_backup
(backup_encryption_key=None, repository_name=None, restore_file=None, restore_include_adeos=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Triggers a configuration DB restore job on the ISE node. The API returns the task ID. Use the Task Service status API to get the status of the backup job.
- Parameters
backup_encryption_key (string) – The encryption key which was provided at the time of taking backup., property of the request body.
repository_name (string) – Name of the configred repository where the backup file exists., property of the request body.
restore_file (string) – Name of the backup file to be restored on ISE node., property of the request body.
restore_include_adeos (string) – Determines whether the ADE-OS configure is restored. Possible values true, false, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
restore
(backup_encryption_key=None, repository_name=None, restore_file=None, restore_include_adeos=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for restore_config_backup
-
update_scheduled_config_backup
(backup_description=None, backup_encryption_key=None, backup_name=None, end_date=None, frequency=None, month_day=None, repository_name=None, start_date=None, status=None, time=None, week_day=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Update the Schedule of the configuration backup on the ISE node as per the input parameters. This API only helps in editing the schedule.
- Parameters
backup_description (string) – Description of the backup., property of the request body.
backup_encryption_key (string) – The encyption key for the backed up file. Encryption key must satisfy the following criteria Contains at least one uppercase letter [A-Z], Contains at least one lowercase letter [a-z], Contains at least one digit [0-9], Contain only [A-Z][a-z][0-9]_#, Has at least 8 characters, Has not more than 15 characters, Must not contain ‘CcIiSsCco’, Must not begin with, property of the request body.
backup_name (string) – The backup file will get saved with this name., property of the request body.
end_date (string) – End date of the scheduled backup job. Allowed format MM/DD/YYYY. End date is not required in case of ONE_TIME frequency., property of the request body.
frequency (string) – frequency, property of the request body. Available values are ‘DAILY’, ‘MONTHLY’, ‘ONCE’ and ‘WEEKLY’.
month_day (string) – Day of month you want backup to be performed on when scheduled frequency is MONTHLY. Allowed values from 1 to 28., property of the request body.
repository_name (string) – Name of the configured repository where the generated backup file will get copied., property of the request body.
start_date (string) – Start date for scheduling the backup job. Allowed format MM/DD/YYYY., property of the request body.
status (string) – status, property of the request body. Available values are ‘DISABLE’ and ‘ENABLE’.
time (string) – Time at which backup job get scheduled. example12:00 AM, property of the request body.
week_day (string) – weekDay, property of the request body. Available values are ‘FRI’, ‘MON’, ‘SAT’, ‘SUN’, ‘THU’, ‘TUE’ and ‘WED’.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update
(backup_description=None, backup_encryption_key=None, backup_name=None, end_date=None, frequency=None, month_day=None, repository_name=None, start_date=None, status=None, time=None, week_day=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_scheduled_config_backup
-
create_scheduled_config_backup
(backup_description=None, backup_encryption_key=None, backup_name=None, end_date=None, frequency=None, month_day=None, repository_name=None, start_date=None, status=None, time=None, week_day=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Schedules the configuration backup on the ISE node as per the input parameters. This API helps in creating the schedule for the first time.
- Parameters
backup_description (string) – Description of the backup., property of the request body.
backup_encryption_key (string) – The encyption key for the backed up file. Encryption key must satisfy the following criteria Contains at least one uppercase letter [A-Z], Contains at least one lowercase letter [a-z], Contains at least one digit [0-9], Contain only [A-Z][a-z][0-9]_#, Has at least 8 characters, Has not more than 15 characters, Must not contain ‘CcIiSsCco’, Must not begin with, property of the request body.
backup_name (string) – The backup file will get saved with this name., property of the request body.
end_date (string) – End date of the scheduled backup job. Allowed format MM/DD/YYYY. End date is not required in case of ONE_TIME frequency., property of the request body.
frequency (string) – frequency, property of the request body. Available values are ‘DAILY’, ‘MONTHLY’, ‘ONCE’ and ‘WEEKLY’.
month_day (string) – Day of month you want backup to be performed on when scheduled frequency is MONTHLY. Allowed values from 1 to 28., property of the request body.
repository_name (string) – Name of the configured repository where the generated backup file will get copied., property of the request body.
start_date (string) – Start date for scheduling the backup job. Allowed format MM/DD/YYYY., property of the request body.
status (string) – status, property of the request body. Available values are ‘DISABLE’ and ‘ENABLE’.
time (string) – Time at which backup job get scheduled. example12:00 AM, property of the request body.
week_day (string) – weekDay, property of the request body. Available values are ‘FRI’, ‘MON’, ‘SAT’, ‘SUN’, ‘THU’, ‘TUE’ and ‘WED’.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(backup_description=None, backup_encryption_key=None, backup_name=None, end_date=None, frequency=None, month_day=None, repository_name=None, start_date=None, status=None, time=None, week_day=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_scheduled_config_backup
-
certificate_profile¶
-
class
CertificateProfile
[source]¶ Identity Services Engine CertificateProfile API (version: 3.1.1).
Wraps the Identity Services Engine CertificateProfile API and exposes the API as native Python methods that return native Python objects.
The certificate profile API allows the client to add, search and perform actions on the certificate profiles.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.4
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Default Values
Example Values
name
String
Yes
Resource Name
Certificate_Profile
id
String
No
Resource UUID
f9269682-dcaf-11e3-ad0a-5bdcd2d9fd69
description
String
No
allowedAsUserName
Boolean
No
To be set true or false
false
externalIdentityStoreName
String
No
Referred IDStore name for the Certificate Profile or [not applicable] in case no identity store is chosen
[not applicable]
[not applicable]
certificateAttributeName
ENUM
No
Attribute name of the Certificate Profile - used only when CERTIFICATE is chosen in usernameFrom. Allowed values: - SUBJECT_COMMON_NAME - SUBJECT_ALTERNATIVE_NAME - SUBJECT_SERIAL_NUMBER - SUBJECT - SUBJECT_ALTERNATIVE_NAME_OTHER_NAME - SUBJECT_ALTERNATIVE_NAME_EMAIL - SUBJECT_ALTERNATIVE_NAME_DNS. - Additional internal value ALL_SUBJECT_AND_ALTERNATIVE_NAMES is used automatically when usernameFrom=UPN
SUBJECT_COMMON_NAME
matchMode
ENUM
No
Match mode of the Certificate Profile. Allowed values: NEVER, RESOLVE_IDENTITY_AMBIGUITY, BINARY_COMPARISON
NEVER
usernameFrom
ENUM
No
The attribute in the certificate where the user name should be taken from.
CERTIFICATE
-
get_certificate_profile_by_name
(name, headers=None, **query_parameters)[source]¶ This API allows the client to get a certificate profile by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_name
(name, headers=None, **query_parameters)[source]¶ Alias for get_certificate_profile_by_name
-
get_certificate_profile_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get a certificate profile by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_certificate_profile_by_id
-
update_certificate_profile_by_id
(id, allowed_as_user_name=None, certificate_attribute_name=None, description=None, external_identity_store_name=None, match_mode=None, name=None, username_from=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update a certificate profile.
- Parameters
allowed_as_user_name (boolean) – allowedAsUserName, property of the request body.
certificate_attribute_name (string) – Attribute name of the Certificate Profile used only when CERTIFICATE is chosen in usernameFrom. Allowed values: SUBJECT_COMMON_NAME SUBJECT_ALTERNATIVE_NAME SUBJECT_SERIAL_NUMBER SUBJECT SUBJECT_ALTERNATIVE_NAME_OTHER_NAME SUBJECT_ALTERNATIVE_NAME_EMAIL SUBJECT_ALTERNATIVE_NAME_DNS. Additional internal value ALL_SUBJECT_AND_ALTERNATIVE_NAMES is used automatically when usernameFrom=UPN, property of the request body.
description (string) – description, property of the request body.
external_identity_store_name (string) – Referred IDStore name for the Certificate Profile or [not applicable] in case no identity store is chosen, property of the request body.
id (basestring) – id, property of the request body.
match_mode (string) – Match mode of the Certificate Profile. Allowed values: NEVER RESOLVE_IDENTITY_AMBIGUITY BINARY_COMPARISON, property of the request body.
name (string) – name, property of the request body.
username_from (string) – The attribute in the certificate where the user name should be taken from. Allowed values: CERTIFICATE (for a specific attribute as defined in certificateAttributeName) UPN (for using any Subject or Alternative Name Attributes in the Certificate an option only in AD), property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, allowed_as_user_name=None, certificate_attribute_name=None, description=None, external_identity_store_name=None, match_mode=None, name=None, username_from=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_certificate_profile_by_id
-
get_certificate_profile
(page=None, size=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the certificate profiles.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_certificate_profile
-
get_certificate_profile_generator
(page=None, size=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the certificate profiles.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_certificate_profile_generator
-
create_certificate_profile
(allowed_as_user_name=None, certificate_attribute_name=None, description=None, external_identity_store_name=None, id=None, match_mode=None, name=None, username_from=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to create a certificate profile.
- Parameters
allowed_as_user_name (boolean) – allowedAsUserName, property of the request body.
certificate_attribute_name (string) – Attribute name of the Certificate Profile used only when CERTIFICATE is chosen in usernameFrom. Allowed values: SUBJECT_COMMON_NAME SUBJECT_ALTERNATIVE_NAME SUBJECT_SERIAL_NUMBER SUBJECT SUBJECT_ALTERNATIVE_NAME_OTHER_NAME SUBJECT_ALTERNATIVE_NAME_EMAIL SUBJECT_ALTERNATIVE_NAME_DNS. Additional internal value ALL_SUBJECT_AND_ALTERNATIVE_NAMES is used automatically when usernameFrom=UPN, property of the request body.
description (string) – description, property of the request body.
external_identity_store_name (string) – Referred IDStore name for the Certificate Profile or [not applicable] in case no identity store is chosen, property of the request body.
id (string) – id, property of the request body.
match_mode (string) – Match mode of the Certificate Profile. Allowed values: NEVER RESOLVE_IDENTITY_AMBIGUITY BINARY_COMPARISON, property of the request body.
name (string) – name, property of the request body.
username_from (string) – The attribute in the certificate where the user name should be taken from. Allowed values: CERTIFICATE (for a specific attribute as defined in certificateAttributeName) UPN (for using any Subject or Alternative Name Attributes in the Certificate an option only in AD), property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(allowed_as_user_name=None, certificate_attribute_name=None, description=None, external_identity_store_name=None, id=None, match_mode=None, name=None, username_from=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_certificate_profile
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the certificate profile.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
certificate_template¶
-
class
CertificateTemplate
[source]¶ Identity Services Engine CertificateTemplate API (version: 3.1.1).
Wraps the Identity Services Engine CertificateTemplate API and exposes the API as native Python methods that return native Python objects.
The certificate template API provides the ability to search for certificate templates.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.2
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Example Values
name
String
Yes
Resource Name
id
String
No
Resource UUID
f9269682-dcaf-11e3-ad0a-5bdcd2d9fd69
description
String
No
raProfileName
String
Yes
RA profile for the Certificate template
ISE internal CA
keySize
Integer
No
Key Size of the Certificate Template
2048 1024
validity
Integer
No
Validity period of the Certificate Template: Valid Range 21 - 3652
730
-
get_certificate_template_by_name
(name, headers=None, **query_parameters)[source]¶ This API allows the client to get a certificate template by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_name
(name, headers=None, **query_parameters)[source]¶ Alias for get_certificate_template_by_name
-
get_certificate_template_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get a certificate template by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_certificate_template_by_id
-
get_certificate_template
(page=None, size=None, headers=None, **query_parameters)[source]¶ This API allows the client to get aall the certificate templates.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_certificate_template
-
get_certificate_template_generator
(page=None, size=None, headers=None, **query_parameters)[source]¶ This API allows the client to get aall the certificate templates.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_certificate_template_generator
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the certificate template.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
certificates¶
-
class
Certificates
[source]¶ Identity Services Engine Certificates API (version: 3.1.1).
Wraps the Identity Services Engine Certificates API and exposes the API as native Python methods that return native Python objects.
-
get_csrs
(filter=None, filter_type=None, page=None, size=None, sort=None, sort_by=None, headers=None, **query_parameters)[source]¶ This API supports Filtering, Sorting and Pagination. Filtering and Sorting supported on below mentioned attributes: friendlyName subject timeStamp Supported Date Format: yyyy-MM-dd HH:mm:ss.SSS Supported Operators: EQ, NEQ, GT and LT .
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sort (basestring) – sort query parameter. sort type asc or desc.
sort_by (basestring) – sortBy query parameter. sort column by which objects needs to be sorted.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. OPERATOR DESCRIPTION EQ Equals NEQ Not Equals GT Greater Than LT Less Then STARTSW Starts With NSTARTSW Not Starts With ENDSW Ends With NENDSW Not Ends With CONTAINS Contains NCONTAINS Not Contains .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_csrs_generator
(filter=None, filter_type=None, page=None, size=None, sort=None, sort_by=None, headers=None, **query_parameters)[source]¶ This API supports Filtering, Sorting and Pagination. Filtering and Sorting supported on below mentioned attributes: friendlyName subject timeStamp Supported Date Format: yyyy-MM-dd HH:mm:ss.SSS Supported Operators: EQ, NEQ, GT and LT .
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sort (basestring) – sort query parameter. sort type asc or desc.
sort_by (basestring) – sortBy query parameter. sort column by which objects needs to be sorted.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. OPERATOR DESCRIPTION EQ Equals NEQ Not Equals GT Greater Than LT Less Then STARTSW Starts With NSTARTSW Not Starts With ENDSW Ends With NENDSW Not Ends With CONTAINS Contains NCONTAINS Not Contains .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
generate_csr
(allow_wild_card_cert=None, certificate_policies=None, digest_type=None, hostnames=None, key_length=None, key_type=None, portal_group_tag=None, san_dir=None, san_dns=None, san_ip=None, san_uri=None, subject_city=None, subject_common_name=None, subject_country=None, subject_org=None, subject_org_unit=None, subject_state=None, used_for=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Generate a certificate signing request for Multi-Use, Admin, EAP Authentication, RADIUS DTLS, PxGrid, SAML, Portal and IMS Services. Following parameters are present in POST request body PARAMETER DESCRIPTION EXAMPLE hostnames List of Cisco ISE node hostnames for which CSRs should be generated “hostnames”: [“ise-host1”, “ise-host2”] allowWildCardCert Allow use of WildCards in certificates “allowWildCardCert”: false keyLength * required Length of the key used for CSR generation (required). “keyLength”: “512” keyType * required Type of key used for CSR generation either RSA or ECDSA (required). “keyType”: “RSA” digestType * required Hash algorithm used for signing CSR (required). “digestType”: “SHA-256” usedFor * required Certificate usage (required). “usedFor”: “MULTI-USE” certificatePolicies Certificate policy OID or list of OIDs that the certificate should conform to. Use comma or space to separate the OIDs. “certificatePolicies”: “Certificate Policies” subjectCommonName * required Certificate common name (CN) (required). “subjectCommonName”: “$FQDN$” subjectOrgUnit Certificate organizational unit (OU). “subjectOrgUnit”: “Engineering” subjectOrg Certificate organization (O). “subjectOrg”: “Cisco” subjectCity Certificate city or locality (L). “subjectCity”: “San Jose” subjectState Certificate state (ST). “subjectState”: “California” subjectCountry Certificate country (C). “subjectCountry”: “US” sanDNS Array of SAN (Subject Alternative Name) DNS entries (optional). “sanDNS”: [“ise.example.com”] sanIP Array of SAN IP entries (optional). “sanIP”: [“1.1.1.1”] sanURI Array of SAN URI entries (optional). “sanURI”: [”https://1.1.1.1”] sanDir Array of SAN DIR entries (optional). “sanDir”: [“CN=AAA,DC=COM,C=IL”] portalGroupTag Portal Group Tag when using certificate for PORTAL service “portalGroupTag”: “Default Portal Certificate Group” NOTE: For allowWildCardCert to be false, the below mentioned parameter is mandatory: hostnames When certificate is selected to be used for Portal Service, the below mentioned parameter is mandatory: portalGroupTag .
- Parameters
allow_wild_card_cert (boolean) – allowWildCardCert, property of the request body.
certificate_policies (string) – certificatePolicies, property of the request body.
digest_type (string) – digestType, property of the request body. Available values are ‘SHA-256’, ‘SHA-384’ and ‘SHA-512’.
hostnames (list) – hostnames, property of the request body (list of strings).
key_length (string) – keyLength, property of the request body. Available values are ‘1024’, ‘2048’, ‘4096’ and ‘512’.
key_type (string) – keyType, property of the request body. Available values are ‘ECDSA’ and ‘RSA’.
portal_group_tag (string) – portalGroupTag, property of the request body.
san_dns (list) – sanDNS, property of the request body (list of strings).
san_dir (list) – sanDir, property of the request body (list of strings).
san_ip (list) – sanIP, property of the request body (list of strings).
san_uri (list) – sanURI, property of the request body (list of strings).
subject_city (string) – subjectCity, property of the request body.
subject_common_name (string) – subjectCommonName, property of the request body.
subject_country (string) – subjectCountry, property of the request body.
subject_org (string) – subjectOrg, property of the request body.
subject_org_unit (string) – subjectOrgUnit, property of the request body.
subject_state (string) – subjectState, property of the request body.
used_for (string) – usedFor, property of the request body. Available values are ‘ADMIN’, ‘DTLS- AUTH’, ‘EAP-AUTH’, ‘IMS’, ‘MULTI-USE’, ‘PORTAL’, ‘PXGRID’ and ‘SAML’.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
export_csr
(hostname, id, dirpath=None, save_file=None, filename=None, headers=None, **query_parameters)[source]¶ Response of this API carries a CSR corresponding to the requested ID.
- Parameters
hostname (basestring) – hostname path parameter. Hostname to which the CSR belongs.
id (basestring) – id path parameter. ID of the CSR to be exported.
dirpath (basestring) – Directory absolute path. Defaults to os.getcwd().
save_file (bool) – Enable or disable automatic file creation of raw response.
filename (basestring) – The filename used to save the download file.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
The DownloadResponse wrapper. Wraps the urllib3.response.HTTPResponse. For more information check the urlib3 documentation
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
DownloadFailure – If was not able to download the raw
response to a file. –
-
generate_intermediate_ca_csr
(headers=None, **query_parameters)[source]¶ CSR Generation for Intermediate Certificates.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_csr_by_id
(host_name, id, headers=None, **query_parameters)[source]¶ This API displays details of a Certificate Signing Request of a particular node for given HostName and ID.
- Parameters
host_name (basestring) – hostName path parameter. Name of the host of which CSR’s should be returned.
id (basestring) – id path parameter. ID of the Certificate Signing Request returned.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_csr_by_id
(host_name, id, headers=None, **query_parameters)[source]¶ This API deletes a Certificate Signing Request of a particular node based on given HostName and ID.
- Parameters
host_name (basestring) – hostName path parameter. Name of the host of which CSR’s should be deleted.
id (basestring) – id path parameter. ID of the Certificate Signing Request to be deleted.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
regenerate_ise_root_ca
(remove_existing_ise_intermediate_csr=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API initiates regeneration of Cisco ISE root CA certificate chain. Response contains ID which can be used to track the status. Setting “removeExistingISEIntermediateCSR” to true removes existing Cisco ISE Intermediate CSR.
- Parameters
remove_existing_ise_intermediate_csr (boolean) – Setting this attribute to true removes existing Cisco ISE Intermediate CSR, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
renew_certificates
(cert_type=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API initiates regeneration of certificates. Response contains ID which can be used to track the status.
- Parameters
cert_type (string) – certType, property of the request body. Available values are ‘IMS’ and ‘OCSP’.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
bind_csr
(admin=None, allow_extended_validity=None, allow_out_of_date_cert=None, allow_replacement_of_certificates=None, allow_replacement_of_portal_group_tag=None, data=None, eap=None, host_name=None, id=None, ims=None, name=None, portal=None, portal_group_tag=None, pxgrid=None, radius=None, saml=None, validate_certificate_extensions=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ - Bind CA Signed Certificate. NOTE: This API requires an
existing Certificate Signing Request, and the root certificate must already be trusted. NOTE: The certificate may have a validity period longer than 398 days. It may be untrusted by many browsers. NOTE: Request parameters accepting True and False as input can be replaced by 1 and 0 respectively. Following parameters are used in POST body PARAMETER DESCRIPTION EXAMPLE name Friendly name of the certificate. “name”: “CA Signed Certificate” data * required Plain-text contents of the certificate file. Every space needs to be replaced with newline escape sequence (
- ) (required). Use awk ‘NF
{sub(/
- /, “”); printf “%sn”,$0;}’ <<your .pem file>>
to extract data from certificate file. “data”: “Plain-text contents of the certificate file.” allowExtendedValidity * required Allow the certificates greater than validity of 398 days (required). “allowExtendedValidity”: true allowOutOfDateCert * required Allow out of date certificates (required). SECURITY ALERT: It is recommended to use “allowOutOfDateCert”: false to avoid binding of expired certificates (not Secure). “allowOutOfDateCert”: true allowReplacementOfCertificates * required Allow Replacement of certificates (required). “allowReplacementOfCertificates”: true allowReplacementOfPortalGroupTag * required Allow Replacement of Portal Group Tag (required). “allowReplacementOfPortalGroupTag”: true admin Use certificate to authenticate the Cisco ISE Admin Portal “admin”: false eap Use certificate for EAP protocols that use SSL/TLS tunneling “eap”: false radius Use certificate for RADSec server “radius”: false pxgrid Use certificate for the pxGrid Controller “pxgrid”: false ims Use certificate for the Cisco ISE Messaging Service “ims”: false saml Use certificate for SAML Signing “saml”: false portal Use certificate for portal “portal”: false portalGroupTag Portal Group Tag for using certificate with portal role “portalGroupTag”: “Default Portal Certificate Group” validateCertificateExtensions Validate Certificate Extensions “validateCertificateExtensions”: false Following roles can be used in any combinations ROLE DEFAULT WARNING Admin False Enabling Admin role for this certificate causes an application server restart on the selected node. Note: Make sure required Certificate Chain is imported under Trusted Certificates EAP Authentication False Only one system certificate can be used for EAP. Assigning EAP to this certificate removes the assignment from another certificate. Note: Make sure required Certificate Chain is imported under Trusted Certificates RADIUS DTLS False Only one system certificate can be used for DTLS. Assigning DTLS to this certificate removes the assignment from another certificate. Note: Make sure required Certificate Chain is imported under Trusted Certificates SAML False SAML cannot be used with other Usage. Enabling SAML unchecks all other Usage. Note: Make sure required Certificate Chain is imported under Trusted Certificates .
- Args:
- admin(boolean): Use certificate to authenticate the
Cisco ISE Admin Portal, property of the request body.
- allow_extended_validity(boolean): Allow import of
certificates with validity greater than 398 days (required), property of the request body.
- allow_out_of_date_cert(boolean): Allow out of date
certificates (required), property of the request body.
- allow_replacement_of_certificates(boolean): Allow
Replacement of certificates (required), property of the request body.
- allow_replacement_of_portal_group_tag(boolean): Allow
Replacement of Portal Group Tag (required), property of the request body.
- data(string): Signed certificate data (required),
property of the request body.
- eap(boolean): Use certificate for EAP protocols that use
SSL/TLS tunneling, property of the request body.
- host_name(string): Name of Host whose CSR ID has been
provided (required), property of the request body.
- id(string): ID of the generated CSR (required), property
of the request body.
- ims(boolean): Use certificate for the Cisco ISE
Messaging Service, property of the request body.
- name(string): Friendly Name of the certificate, property
of the request body.
- portal(boolean): Use for portal, property of the request
body.
- portal_group_tag(string): Set Group tag, property of the
request body.
- pxgrid(boolean): Use certificate for the pxGrid
Controller, property of the request body.
- radius(boolean): Use certificate for the RADSec server,
property of the request body.
- saml(boolean): Use certificate for SAML Signing,
property of the request body.
- validate_certificate_extensions(boolean): Validate
Certificate Extensions, property of the request body.
- headers(dict): Dictionary of HTTP Headers to send with the Request
.
- payload(dict): A JSON serializable Python object to send in the
body of the Request.
- active_validation(bool): Enable/Disable payload validation.
Defaults to True.
- **query_parameters: Additional query parameters (provides
support for parameters that may be added in the future).
Returns:
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Raises:
TypeError: If the parameter types are incorrect. MalformedRequest: If the request body created is invalid. ApiError: If the Identity Services Engine cloud returns an error.
-
export_system_certificate
(export=None, id=None, password=None, dirpath=None, save_file=None, filename=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Export System Certificate. Following parameters are used in POST body PARAMETER DESCRIPTION EXAMPLE id * required ID of a System Certificate (required). “id”: “CERT-ID” export One of the below option is required “CERTIFICATE” : Export only certificate without private key “CERTIFICATE_WITH_PRIVATE_KEY” : Export both certificate and private key ( “certificatePassword” is required). “export”: “CERTIFICATE_WITH_PRIVATE_KEY” password * required Certificate password (required if “export” : CERTIFICATE_WITH_PRIVATE_KEY ). Password constraints: Alphanumeric Minimum of 8 Characters Maximum of 100 Characters “password”: “certificate password” NOTE: The response of this API carries a ZIP file containing the certificate and private key if “export” : “CERTIFICATE_WITH_PRIVATE_KEY” in the request. If “export” : “CERTIFICATE” in request body, the response carries a ZIP file containing only the certificate. WARNING: Exporting a private key is not a secure operation. It could lead to possible exposure of the private key. .
- Parameters
export (string) – export, property of the request body. Available values are ‘CERTIFICATE’ and ‘CERTIFICATE_WITH_PRIVATE_KEY’.
id (string) – id, property of the request body.
password (string) – password, property of the request body.
dirpath (basestring) – Directory absolute path. Defaults to os.getcwd().
save_file (bool) – Enable or disable automatic file creation of raw response.
filename (basestring) – The filename used to save the download file.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
The DownloadResponse wrapper. Wraps the urllib3.response.HTTPResponse. For more information check the urlib3 documentation
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
DownloadFailure – If was not able to download the raw
response to a file. –
-
generate_self_signed_certificate
(admin=None, allow_extended_validity=None, allow_portal_tag_transfer_for_same_subject=None, allow_replacement_of_certificates=None, allow_replacement_of_portal_group_tag=None, allow_role_transfer_for_same_subject=None, allow_san_dns_bad_name=None, allow_san_dns_non_resolvable=None, allow_wild_card_certificates=None, certificate_policies=None, digest_type=None, eap=None, expiration_ttl=None, expiration_ttl_unit=None, host_name=None, key_length=None, key_type=None, name=None, portal=None, portal_group_tag=None, pxgrid=None, radius=None, saml=None, san_dns=None, san_ip=None, san_uri=None, subject_city=None, subject_common_name=None, subject_country=None, subject_org=None, subject_org_unit=None, subject_state=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Generate Self-signed Certificate NOTE: The certificate may have a validity period longer than 398 days. It may be untrusted by many browsers. NOTE: Request parameters accepting True and False as input can be replaced by 1 and 0 respectively. NOTE: Wildcard certificate and SAML certificate can be generated only on PPAN or Standalone Following parameters are used in POST body PARAMETER DESCRIPTION EXAMPLE hostName * required Hostname or FQDN of the node in which certificate needs to be created (required). “hostName”: “ise-node-001” name Friendly name of the certificate. “name”: “Self-signed System Certificate” subjectCommonName Certificate common name (CN) NOTE: 1. CN is Mandatory if SAN not configured. 2. Subject can contain a multi- valued CN. For multi-valued RDNs, follow the format “CN=value1, CN=value2” “subjectCommonName”: “$FQDN$” subjectOrgUnit Certificate organizational unit (OU) NOTE: Subject can contain a multi-valued OU. For multi- valued RDNs, follow the format “OU=value1, OU=value2” “subjectOrgUnit”: “Engineering” subjectOrg Certificate organization (O) NOTE: Subject can contain a multi-valued O fields. For multi-valued RDNs, follow the format “O=value1, O=value2” “subjectOrg”: “Cisco” subjectCity Certificate city or locality (L) “subjectCity”: “San Jose” subjectState Certificate state (ST) “subjectState”: “California” subjectCountry Certificate country (C) “subjectCountry”: “US” sanDNS Array of SAN (Subject Alternative Name) DNS entries “sanDNS”: [“ise.example.com”] sanIP Array of SAN IP entries “sanIP”: [“1.1.1.1”] sanURI Array of SAN URI entries “sanURI”: [”https://1.1.1.1”] keyType * required Algorithm to use for certificate public key creation (required). “keyType”: “RSA” keyLength * required Bit size of the public key (required). “keyLength”: “4096” digestType * required Digest to sign with (required). “digestType”: “SHA-384” certificatePolicies Certificate policy OID or list of OIDs that the certificate should conform to. Use comma or space to separate the OIDs. “certificatePolicies”: “Certificate Policies” expirationTTL * required Certificate expiration value (required). NOTE: Expiration TTL should be within Unix time limit “expirationTTL”: 2 expirationTTLUnit * required Certificate expiration unit (required). “expirationTTLUnit”: “years” admin Use certificate to authenticate the Cisco ISE Admin Portal “admin”: false eap Use certificate for EAP protocols that use SSL/TLS tunneling “eap”: false radius Use certificate for RADSec server “radius”: false pxgrid Use certificate for the pxGrid Controller “pxgrid”: false saml Use certificate for SAML Signing “saml”: false portal Use certificate for portal “portal”: false portalGroupTag Portal Group Tag for using certificate with portal role “portalGroupTag”: “Default Portal Certificate Group” allowReplacementOfPortalGroupTag * required Allow Replacement of Portal Group Tag (required). “allowReplacementOfPortalGroupTag”: true allowWildCardCertificates Allow use of WildCards in certificates “allowWildCardCertificates”: false allowReplacementOfCertificates * required Allow replacement of certificates (required). “allowReplacementOfCertificates”: true allowExtendedValidity * required Allow generation of self-signed certificate with validity greater than 398 days (required). “allowExtendedValidity”: true allowRoleTransferForSameSubject * required Allow the transfer of roles to certificates with same subject (required). If the matching certificate on Cisco ISE has either admin or portal role and if request has admin or portal role selected along with allowRoleTransferForSameSubject parameter as true, self- signed certificate would be generated with both admin and portal role enabled “allowRoleTransferForSameSubject”: true allowPortalTagTransferForSameSubject * required Acquire the group tag of the matching certificate (required). If the request portal groug tag is different from the group tag of matching certificate (If matching certificate in Cisco ISE has portal role enabled), self- signed certificate would be generated by acquiring the group tag of matching certificate if allowPortalTagTransferForSameSubject parameter is true “allowPortalTagTransferForSameSubject”: true allowSanDnsBadName * required Allow generation of self-signed certificate with bad Common Name & SAN Values [like “example.org.”,”invalid.”,”test.”,”localhost” ,etc.] (required). SECURITY ALERT: It is recommended to use “allowSanDnsBadName”: false to avoid generation of certificates with bad Common Name & SAN Values which are not secure “allowSanDnsBadName”: true allowSanDnsNonResolvable * required Allow generation of self-signed certificate with non resolvable Common Name or SAN Values (required). “allowSanDnsNonResolvable”: true ROLE DEFAULT WARNING Admin False Enabling Admin role for this certificate causes an application server restart on the selected node. EAP Authentication False Only one system certificate can be used for EAP. Assigning EAP to this certificate removes the assignment from another certificate. RADIUS DTLS False Only one system certificate can be used for DTLS. Assigning DTLS to this certificate removes the assignment from another certificate. SAML False SAML cannot be used with other Usage. .
- Parameters
admin (boolean) – Use certificate to authenticate the Cisco ISE Admin Portal, property of the request body.
allow_extended_validity (boolean) – Allow generation of self-signed certificate with validity greater than 398 days, property of the request body.
allow_portal_tag_transfer_for_same_subject (boolean) – Allow overwriting the portal tag from matching certificate of same subject, property of the request body.
allow_replacement_of_certificates (boolean) – Allow Replacement of certificates, property of the request body.
allow_replacement_of_portal_group_tag (boolean) – Allow Replacement of Portal Group Tag, property of the request body.
allow_role_transfer_for_same_subject (boolean) – Allow transfer of roles for certificate with matching subject, property of the request body.
allow_san_dns_bad_name (boolean) – Allow usage of SAN DNS Bad name, property of the request body.
allow_san_dns_non_resolvable (boolean) – Allow use of non resolvable Common Name or SAN Values, property of the request body.
allow_wild_card_certificates (boolean) – Allow Wildcard Certificates, property of the request body.
certificate_policies (string) – Certificate Policies, property of the request body.
digest_type (string) – Digest to sign with, property of the request body. Available values are ‘SHA-256’, ‘SHA-384’ and ‘SHA-512’.
eap (boolean) – Use certificate for EAP protocols that use SSL/TLS tunneling, property of the request body.
expiration_ttl (integer) – Certificate expiration value, property of the request body.
expiration_ttl_unit (string) – Certificate expiration unit, property of the request body. Available values are ‘days’, ‘months’, ‘weeks’ and ‘years’.
host_name (string) – Hostname of the Cisco ISE node in which self-signed certificate should be generated., property of the request body.
key_length (string) – Bit size of public key, property of the request body. Available values are ‘1024’, ‘2048’, ‘4096’ and ‘512’.
key_type (string) – Algorithm to use for certificate public key creation, property of the request body. Available values are ‘ECDSA’ and ‘RSA’.
name (string) – Friendly name of the certificate., property of the request body.
portal (boolean) – Use for portal, property of the request body.
portal_group_tag (string) – Set Group tag, property of the request body.
pxgrid (boolean) – Use certificate for the pxGrid Controller, property of the request body.
radius (boolean) – Use certificate for the RADSec server, property of the request body.
saml (boolean) – Use certificate for SAML Signing, property of the request body.
san_dns (list) – Array of SAN (Subject Alternative Name) DNS entries, property of the request body (list of strings).
san_ip (list) – Array of SAN IP entries, property of the request body (list of strings).
san_uri (list) – Array of SAN URI entries, property of the request body (list of strings).
subject_city (string) – Certificate city or locality (L), property of the request body.
subject_common_name (string) – Certificate common name (CN), property of the request body.
subject_country (string) – Certificate country (C), property of the request body.
subject_org (string) – Certificate organization (O), property of the request body.
subject_org_unit (string) – Certificate organizational unit (OU), property of the request body.
subject_state (string) – Certificate state (ST), property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
import_system_certificate
(admin=None, allow_extended_validity=None, allow_out_of_date_cert=None, allow_portal_tag_transfer_for_same_subject=None, allow_replacement_of_certificates=None, allow_replacement_of_portal_group_tag=None, allow_role_transfer_for_same_subject=None, allow_sha1_certificates=None, allow_wild_card_certificates=None, data=None, eap=None, ims=None, name=None, password=None, portal=None, portal_group_tag=None, private_key_data=None, pxgrid=None, radius=None, saml=None, validate_certificate_extensions=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ - Import an X509 certificate as a system certificate. NOTE:
The certificate may have a validity period longer than 398 days. It may be untrusted by many browsers. NOTE: Request parameters accepting True and False as input can be replaced by 1 and 0 respectively. Following parameters are used in POST body PARAMETER DESCRIPTION EXAMPLE name Friendly name of the certificate. “name”: “System certificate” password * required Password of the certificate to be imported (required). “password”: “certificate password” data * required Plain-text contents of the certificate file. Every space needs to be replaced with newline escape sequence (
- ) (required).
Use awk ‘NF {sub(/
- /, “”); printf “%sn”,$0;}’ <<your
.pem file>> to extract data from certificate file. “data”: “Plain-text contents of the certificate file.” privateKeyData * required Plain-text contents of the private key file. Every space needs to be replaced with newline escape sequence (
- ) (required). Use awk ‘NF
{sub(/
- /, “”); printf “%sn”,$0;}’ <<your .pem file>>
to extract privateKeyData from private key file. “data”: “Plain-text contents of the private key file.” allowOutOfDateCert * required Allow out of date certificates (required). SECURITY ALERT: It is recommended to use “allowOutOfDateCert”: false to avoid import of expired certificates (not Secure). “allowOutOfDateCert”: true allowSHA1certificates * required Allow import of certificate with signature that uses the SHA-1 hashing algorithm and is considered less secure (required). SECURITY ALERT: It is recommended to use “allowSHA1certificates”: false to avoid import of SHA1 based certificates (less secure). “allowSHA1certificates”: true allowExtendedValidity * required Allow the certificates greater than validity of 398 days (required). “allowExtendedValidity”: true allowRoleTransferForSameSubject Allow the transfer of roles to certificates with same subject “allowRoleTransferForSameSubject”: true allowPortalTagTransferForSameSubject Acquire the group tag of the matching certificate “allowPortalTagTransferForSameSubject”: true admin Use certificate to authenticate the Cisco ISE Admin Portal “admin”: false eap Use certificate for EAP protocols that use SSL/TLS tunneling “eap”: false radius Use certificate for RADSec server “radius”: false pxgrid Use certificate for the pxGrid Controller “pxgrid”: false ims Use certificate for the Cisco ISE Messaging Service “ims”: false saml Use certificate for SAML Signing “saml”: false portal Use certificate for portal “portal”: false portalGroupTag Portal Group Tag for using certificate with portal role “portalGroupTag”: “Default Portal certificate Group” allowReplacementOfPortalGroupTag * required Allow Replacement of Portal Group Tag (required). “allowReplacementOfPortalGroupTag”: true allowWildCardcertificates Allow use of WildCards in certificates “allowWildCardcertificates”: false validatecertificateExtensions Validate certificate extensions “validatecertificateExtensions”: false Following roles can be used in any combinations ROLE DEFAULT WARNING Admin False Enabling Admin role for this certificate causes an application server restart on the selected node. Note: Make sure required Certificate Chain is imported under Trusted Certificates EAP Authentication False Only one system certificate can be used for EAP. Assigning EAP to this certificate removes the assignment from another certificate. Note: Make sure required Certificate Chain is imported under Trusted Certificates RADIUS DTLS False Only one system certificate can be used for DTLS. Assigning DTLS to this certificate removes the assignment from another certificate. Note: Make sure required Certificate Chain is imported under Trusted Certificates SAML False SAML cannot be used with other Usage. Enabling SAML unchecks all other Usage. Note: Make sure required Certificate Chain is imported under Trusted Certificates .
- Args:
- admin(boolean): Use certificate to authenticate the
Cisco ISE Admin Portal, property of the request body.
- allow_extended_validity(boolean): Allow import of
certificates with validity greater than 398 days (required), property of the request body.
- allow_out_of_date_cert(boolean): Allow out of date
certificates (required), property of the request body.
- allow_portal_tag_transfer_for_same_subject(boolean):
Allow overwriting the portal tag from matching certificate of same subject, property of the request body.
- allow_replacement_of_certificates(boolean): Allow
Replacement of certificates (required), property of the request body.
- allow_replacement_of_portal_group_tag(boolean): Allow
Replacement of Portal Group Tag (required), property of the request body.
- allow_role_transfer_for_same_subject(boolean): Allow
transfer of roles for certificate with matching subject , property of the request body.
- allow_sha1_certificates(boolean): Allow SHA1 based
certificates (required), property of the request body.
- allow_wild_card_certificates(boolean): Allow Wildcard
certificates, property of the request body.
- data(string): Certificate Content (required), property
of the request body.
- eap(boolean): Use certificate for EAP protocols that use
SSL/TLS tunneling, property of the request body.
- ims(boolean): Use certificate for the Cisco ISE
Messaging Service, property of the request body.
- name(string): Name of the certificate, property of the
request body.
- password(string): Certificate Password (required).,
property of the request body.
- portal(boolean): Use for portal, property of the request
body.
- portal_group_tag(string): Set Group tag, property of the
request body.
- private_key_data(string): Private Key data (required),
property of the request body.
- pxgrid(boolean): Use certificate for the pxGrid
Controller, property of the request body.
- radius(boolean): Use certificate for the RADSec server,
property of the request body.
- saml(boolean): Use certificate for SAML Signing,
property of the request body.
- validate_certificate_extensions(boolean): Validate
certificate extensions, property of the request body.
- headers(dict): Dictionary of HTTP Headers to send with the Request
.
- payload(dict): A JSON serializable Python object to send in the
body of the Request.
- active_validation(bool): Enable/Disable payload validation.
Defaults to True.
- **query_parameters: Additional query parameters (provides
support for parameters that may be added in the future).
Returns:
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Raises:
TypeError: If the parameter types are incorrect. MalformedRequest: If the request body created is invalid. ApiError: If the Identity Services Engine cloud returns an error.
-
get_system_certificates
(host_name, filter=None, filter_type=None, page=None, size=None, sort=None, sort_by=None, headers=None, **query_parameters)[source]¶ This API supports Filtering, Sorting and Pagination. Filtering and Sorting supported on below mentioned attributes: friendlyName issuedTo issuedBy validFrom Supported Date Format: yyyy-MM-dd HH:mm:ss Supported Operators: EQ, NEQ, GT and LT expirationDate Supported Date Format: yyyy-MM-dd HH:mm:ss Supported Operators: EQ, NEQ, GT and LT .
- Parameters
host_name (basestring) – hostName path parameter. Name of the host of which system certificates should be returned.
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sort (basestring) – sort query parameter. sort type asc or desc.
sort_by (basestring) – sortBy query parameter. sort column by which objects needs to be sorted.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. OPERATOR DESCRIPTION EQ Equals NEQ Not Equals GT Greater Than LT Less Then STARTSW Starts With NSTARTSW Not Starts With ENDSW Ends With NENDSW Not Ends With CONTAINS Contains NCONTAINS Not Contains .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_system_certificates_generator
(host_name, filter=None, filter_type=None, page=None, size=None, sort=None, sort_by=None, headers=None, **query_parameters)[source]¶ This API supports Filtering, Sorting and Pagination. Filtering and Sorting supported on below mentioned attributes: friendlyName issuedTo issuedBy validFrom Supported Date Format: yyyy-MM-dd HH:mm:ss Supported Operators: EQ, NEQ, GT and LT expirationDate Supported Date Format: yyyy-MM-dd HH:mm:ss Supported Operators: EQ, NEQ, GT and LT .
- Parameters
host_name (basestring) – hostName path parameter. Name of the host of which system certificates should be returned.
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sort (basestring) – sort query parameter. sort type asc or desc.
sort_by (basestring) – sortBy query parameter. sort column by which objects needs to be sorted.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. OPERATOR DESCRIPTION EQ Equals NEQ Not Equals GT Greater Than LT Less Then STARTSW Starts With NSTARTSW Not Starts With ENDSW Ends With NENDSW Not Ends With CONTAINS Contains NCONTAINS Not Contains .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_system_certificate_by_id
(host_name, id, headers=None, **query_parameters)[source]¶ This API provides details of a System Certificate of a particular node based on given HostName and ID.
- Parameters
host_name (basestring) – hostName path parameter. Name of the host of which system certificates should be returned.
id (basestring) – id path parameter. ID of the system certificate.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_system_certificate
(host_name, id, admin=None, allow_portal_tag_transfer_for_same_subject=None, allow_replacement_of_portal_group_tag=None, allow_role_transfer_for_same_subject=None, description=None, eap=None, expiration_ttl_period=None, expiration_ttl_units=None, ims=None, name=None, portal=None, portal_group_tag=None, pxgrid=None, radius=None, renew_self_signed_certificate=None, saml=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Update a System Certificate. NOTE: Renewing a certificate causes an application server restart on the selected node. NOTE: Request parameters accepting True and False as input can be replaced by 1 and 0 respectively. Following parameters are used in POST body PARAMETER DESCRIPTION EXAMPLE name Friendly name of the certificate. “name”: “System Certificate” description Description of the certificate “description”: “Description of certificate” admin Use certificate to authenticate the Cisco ISE Admin Portal “admin”: false eap Use certificate for EAP protocols that use SSL/TLS tunneling “eap”: false radius Use certificate for RADSec server “radius”: false pxgrid Use certificate for the pxGrid Controller “pxgrid”: false ims Use certificate for the Cisco ISE Messaging Service “ims”: false saml Use certificate for SAML Signing “saml”: false portal Use certificate for portal “portal”: false portalGroupTag Portal Group Tag for using certificate with portal role “portalGroupTag”: “Default Portal Certificate Group” allowReplacementOfPortalGroupTag * required Allow Replacement of Portal Group Tag (required). “allowReplacementOfPortalGroupTag”: true allowRoleTransferForSameSubjec * required t Allow transfer of roles to certificates with same subject (required). “allowRoleTransferForSameSubject”: true allowPortalTagTransferForSameSubject * required Acquire group tag of the matching certificate (required). “allowPortalTagTransferForSameSubject”: true renewSelfSignedCertificate Renew Self- signed Certificate “renewSelfSignedCertificate”: false expirationTTLPeriod Expiration Period “expirationTTLPeriod”: 365 expirationTTLUnits Expiration Units in one of the below formats days / weeks / months / years “expirationTTLUnits”: “days” Following roles can be used in any combinations ROLE DEFAULT WARNING Admin False Enabling Admin role for this certificate causes an application server restart on the selected node. Note: Make sure required Certificate Chain is imported under Trusted Certificates EAP Authentication False Only one system certificate can be used for EAP. Assigning EAP to this certificate removes the assignment from another certificate. Note: Make sure required Certificate Chain is imported under Trusted Certificates RADIUS DTLS False Only one system certificate can be used for DTLS. Assigning DTLS to this certificate removes the assignment from another certificate. Note: Make sure required Certificate Chain is imported under Trusted Certificates SAML False SAML cannot be used with other Usage. Enabling SAML unchecks all other Usage. Note: Make sure required Certificate Chain is imported under Trusted Certificates .
- Parameters
admin (boolean) – Use certificate to authenticate the Cisco ISE Admin Portal, property of the request body.
allow_portal_tag_transfer_for_same_subject (boolean) – Allow overwriting the portal tag from matching certificate of same subject, property of the request body.
allow_replacement_of_portal_group_tag (boolean) – Allow Replacement of Portal Group Tag (required), property of the request body.
allow_role_transfer_for_same_subject (boolean) – Allow transfer of roles for certificate with matching subject , property of the request body.
description (string) – Description of System Certificate, property of the request body.
eap (boolean) – Use certificate for EAP protocols that use SSL/TLS tunneling, property of the request body.
expiration_ttl_period (integer) – expirationTTLPeriod, property of the request body.
expiration_ttl_units (string) – expirationTTLUnits, property of the request body. Available values are ‘days’, ‘months’, ‘weeks’ and ‘years’.
ims (boolean) – Use certificate for the Cisco ISE Messaging Service, property of the request body.
name (string) – Name of the certificate, property of the request body.
portal (boolean) – Use for portal, property of the request body.
portal_group_tag (string) – Set Group tag, property of the request body.
pxgrid (boolean) – Use certificate for the pxGrid Controller, property of the request body.
radius (boolean) – Use certificate for the RADSec server, property of the request body.
renew_self_signed_certificate (boolean) – Renew Self- signed Certificate, property of the request body.
saml (boolean) – Use certificate for SAML Signing, property of the request body.
id (basestring) – id path parameter. ID of the System Certificate to be updated.
host_name (basestring) – hostName path parameter. Name of Host whose certificate needs to be updated.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_system_certificate_by_id
(host_name, id, headers=None, **query_parameters)[source]¶ This API deletes a System Certificate of a particular node based on given HostName and ID.
- Parameters
host_name (basestring) – hostName path parameter. Name of the host from which System Certificate needs to be deleted.
id (basestring) – id path parameter. ID of the System Certificate to be deleted.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_trusted_certificates
(filter=None, filter_type=None, page=None, size=None, sort=None, sort_by=None, headers=None, **query_parameters)[source]¶ This API supports Filtering, Sorting and Pagination. Filtering and Sorting supported on below mentioned attributes: friendlyName subject issuedTo issuedBy validFrom Supported Date Format: yyyy-MM- dd HH:mm:ss Supported Operators: EQ, NEQ, GT and LT expirationDate Supported Date Format: yyyy-MM-dd HH:mm:ss Supported Operators: EQ, NEQ, GT and LT status Allowed values: enabled, disabled Supported Operators: EQ, NEQ .
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sort (basestring) – sort query parameter. sort type asc or desc.
sort_by (basestring) – sortBy query parameter. sort column by which objects needs to be sorted.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. OPERATOR DESCRIPTION EQ Equals NEQ Not Equals GT Greater Than LT Less Then STARTSW Starts With NSTARTSW Not Starts With ENDSW Ends With NENDSW Not Ends With CONTAINS Contains NCONTAINS Not Contains .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_trusted_certificates_generator
(filter=None, filter_type=None, page=None, size=None, sort=None, sort_by=None, headers=None, **query_parameters)[source]¶ This API supports Filtering, Sorting and Pagination. Filtering and Sorting supported on below mentioned attributes: friendlyName subject issuedTo issuedBy validFrom Supported Date Format: yyyy-MM- dd HH:mm:ss Supported Operators: EQ, NEQ, GT and LT expirationDate Supported Date Format: yyyy-MM-dd HH:mm:ss Supported Operators: EQ, NEQ, GT and LT status Allowed values: enabled, disabled Supported Operators: EQ, NEQ .
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sort (basestring) – sort query parameter. sort type asc or desc.
sort_by (basestring) – sortBy query parameter. sort column by which objects needs to be sorted.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. OPERATOR DESCRIPTION EQ Equals NEQ Not Equals GT Greater Than LT Less Then STARTSW Starts With NSTARTSW Not Starts With ENDSW Ends With NENDSW Not Ends With CONTAINS Contains NCONTAINS Not Contains .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
export_trusted_certificate
(id, dirpath=None, save_file=None, filename=None, headers=None, **query_parameters)[source]¶ The response of this API carries a trusted certificate file mapped to the requested ID.
- Parameters
id (basestring) – id path parameter. ID of the Trusted Certificate to be exported.
dirpath (basestring) – Directory absolute path. Defaults to os.getcwd().
save_file (bool) – Enable or disable automatic file creation of raw response.
filename (basestring) – The filename used to save the download file.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
The DownloadResponse wrapper. Wraps the urllib3.response.HTTPResponse. For more information check the urlib3 documentation
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
DownloadFailure – If was not able to download the raw
response to a file. –
-
import_trust_certificate
(allow_basic_constraint_cafalse=None, allow_out_of_date_cert=None, allow_sha1_certificates=None, data=None, description=None, name=None, trust_for_certificate_based_admin_auth=None, trust_for_cisco_services_auth=None, trust_for_client_auth=None, trust_for_ise_auth=None, validate_certificate_extensions=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ - Import an X509 certificate as a trust certificate. NOTE:
Request parameters accepting True and False as input can be replaced by 1 and 0 respectively. Following parameters are used in POST body PARAMETER DESCRIPTION EXAMPLE name Friendly name of the certificate “name”: “Trust Certificate” description Description of the certificate “description”: “Imported Trust Certificate” data * required Plain-text contents of the certificate file. Every space needs to be replaced with newline escape sequence (
) (required). Use awk ‘NF {sub(/ /, “”);
printf “%sn”,$0;}’ <<your .pem file>> to extract data from certificate file. “data”: “Plain-text contents of the certificate file.” allowOutOfDateCert * required Allow out of date certificates (required). SECURITY ALERT: It is recommended to use “allowOutOfDateCert”: false to avoid import of expired certificates (not Secure). “allowOutOfDateCert”: true allowSHA1Certificates * required Allow import of certificate with signature that uses SHA-1 hashing algorithm and is considered less secure (required). SECURITY ALERT: It is recommended to use “allowSHA1Certificates”: false to avoid import of SHA1 based certificates (less secure). “allowSHA1Certificates”: true allowBasicConstraintCAFalse * required Allow certificates with Basic Constraints CA Field as False (required). SECURITY ALERT: It is recommended to use “allowBasicConstraintCAFalse”: false to avoid import of certificates with Basic Constraints CA Field as False (not Secure). “allowBasicConstraintCAFalse”: true trustForIseAuth Trust for authentication within Cisco ISE “trustForIseAuth”: false trustForClientAuth Trust for client authentication and Syslog “trustForClientAuth”: false trustForCertificateBasedAdminAuth Trust for certificate based Admin authentication “trustForCertificateBasedAdminAuth”: false trustForCiscoServicesAuth Trust for authentication of Cisco Services “trustForCiscoServicesAuth”: false validateCertificateExtensions Validate extensions for trust certificate “validateCertificateExtensions”: false NOTE: If name is not set, a default name with the following format is used: common- name#issuer#nnnnn where “nnnnn” is a unique number. You can always change the friendly name later by editing the certificate. You must choose how this certificate is trusted in Cisco ISE. The objective here is to distinguish between certificates that are used for trust within an Cisco ISE deployment and public certificates that are used to trust Cisco services. Typically, you do not want to use a given certificate for both purposes. Trusted For Usage Authentication within Cisco ISE Use “trustForIseAuth”:true if the certificate is used for trust within Cisco ISE, such as for secure communication between Cisco ISE nodes Client authentication and Syslog Use “trustForClientAuth”:true if the certificate is to be used for authentication of endpoints that contact Cisco ISE over the EAP protocol. Also check this box if certificate is used to trust a Syslog server. Make sure to have keyCertSign bit asserted under KeyUsage extension for this certificate. Note: “” can be set true only if the “trustForIseAuth” has been set true. Certificate based admin authentication Use “trustForCertificateBasedAdminAuth”:true if the certificate is used for trust within Cisco ISE, such as for secure communication between Cisco ISE nodes Note: “trustForCertificateBasedAdminAuth” can be set true only if “trustForIseAuth” and “trustForClientAuth” are true. Authentication of Cisco Services Use “trustForCiscoServicesAuth”:true if the certificate is to be used for trusting external Cisco services, such as Feed Service. .
- Args:
- allow_basic_constraint_cafalse(boolean): Allow
certificates with Basic Constraints CA Field as False (required), property of the request body.
- allow_out_of_date_cert(boolean): Allow out of date
certificates (required), property of the request body.
- allow_sha1_certificates(boolean): Allow SHA1 based
certificates (required), property of the request body.
- data(string): Certificate content (required), property
of the request body.
- description(string): Description of the certificate,
property of the request body.
- name(string): Name of the certificate, property of the
request body.
- trust_for_certificate_based_admin_auth(boolean): Trust
for Certificate based Admin authentication, property of the request body.
- trust_for_cisco_services_auth(boolean): Trust for
authentication of Cisco Services, property of the request body.
- trust_for_client_auth(boolean): Trust for client
authentication and Syslog, property of the request body.
- trust_for_ise_auth(boolean): Trust for authentication
within Cisco ISE, property of the request body.
- validate_certificate_extensions(boolean): Validate trust
certificate extension, property of the request body.
- headers(dict): Dictionary of HTTP Headers to send with the Request
.
- payload(dict): A JSON serializable Python object to send in the
body of the Request.
- active_validation(bool): Enable/Disable payload validation.
Defaults to True.
- **query_parameters: Additional query parameters (provides
support for parameters that may be added in the future).
Returns:
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Raises:
TypeError: If the parameter types are incorrect. MalformedRequest: If the request body created is invalid. ApiError: If the Identity Services Engine cloud returns an error.
-
get_trusted_certificate_by_id
(id, headers=None, **query_parameters)[source]¶ This API can displays details of a Trust Certificate based on a given ID.
- Parameters
id (basestring) – id path parameter. ID of the trust certificate.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_trusted_certificate
(id, authenticate_before_crl_received=None, automatic_crl_update=None, automatic_crl_update_period=None, automatic_crl_update_units=None, crl_distribution_url=None, crl_download_failure_retries=None, crl_download_failure_retries_units=None, description=None, download_crl=None, enable_ocsp_validation=None, enable_server_identity_check=None, ignore_crl_expiration=None, name=None, non_automatic_crl_update_period=None, non_automatic_crl_update_units=None, reject_if_no_status_from_ocs_p=None, reject_if_unreachable_from_ocs_p=None, selected_ocsp_service=None, status=None, trust_for_certificate_based_admin_auth=None, trust_for_cisco_services_auth=None, trust_for_client_auth=None, trust_for_ise_auth=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Update a trusted certificate present in Cisco ISE trust store. Following parameters are used in PUT request body PARAMETER DESCRIPTION EXAMPLE name * required Friendly name of the certificate (required). “name”: “Trust Certificate” status Status of the certificate “status”: “Enabled” description Description of the certificate “description”: “Certificate for secure connection to cisco.com” trustForIseAuth Trust for authentication within Cisco ISE “trustForIseAuth”: false trustForClientAuth Trust for client authentication and Syslog “trustForClientAuth”: false trustForCertificateBasedAdminAuth Trust for certificate based Admin authentication “trustForCertificateBasedAdminAuth”: false trustForCiscoServicesAuth Trust for authentication of Cisco Services “trustForCiscoServicesAuth”: false enableOCSPValidation Switch to enable or disable OCSP Validation “enableOCSPValidation”: false selectedOCSPService Name of selected OCSP Service “selectedOCSPService”: “INTERNAL_OCSP_SERVICE” rejectIfNoStatusFromOCSP Switch to reject certificate if there is no status from OCSP “rejectIfNoStatusFromOCSP”: false rejectIfUnreachableFromOCSP Switch to reject certificate if unreachable from OCSP “rejectIfUnreachableFromOCSP”: false downloadCRL Switch to enable or disable download of CRL “downloadCRL”: false crlDistributionUrl Certificate Revocation List Distribution URL “crlDistributionUrl”: “CRL distribution URL” automaticCRLUpdate Switch to enable or disable automatic CRL update “automaticCRLUpdate”: false automaticCRLUpdatePeriod Automatic CRL update period “automaticCRLUpdatePeriod”: 5 automaticCRLUpdateUnits Unit of time for automatic CRL update “automaticCRLUpdateUnits”: “Minutes” nonAutomaticCRLUpdatePeriod Non automatic CRL update period “nonAutomaticCRLUpdatePeriod”: 1 nonAutomaticCRLUpdateUnits Unit of time of non automatic CRL update “nonAutomaticCRLUpdateUnits”: “Hours” crlDownloadFailureRetries If CRL download fails, wait time before retry “crlDownloadFailureRetries”: 10 crlDownloadFailureRetriesUnits Unit of time before retry if CRL download fails “crlDownloadFailureRetriesUnits”: “Minutes” enableServerIdentityCheck Switch to enable or disable verification if HTTPS or LDAP server certificate name fits the configured server URL “enableServerIdentityCheck”: false authenticateBeforeCRLReceived Switch to enable or disable CRL Verification if CRL is not Received “authenticateBeforeCRLReceived”: false ignoreCRLExpiration Switch to enable or disable ignore CRL Expiration “ignoreCRLExpiration”: false Trusted For Usage Authentication within Cisco ISE Use “trustForIseAuth”:true if the certificate is used for trust within Cisco ISE, such as for secure communication between Cisco ISE nodes Client authentication and Syslog Use “trustForClientAuth”:true if the certificate is to be used for authentication of endpoints that contact Cisco ISE over the EAP protocol. Also check this box if certificate is used to trust a Syslog server. Make sure to have keyCertSign bit asserted under KeyUsage extension for this certificate. Note: “trustForClientAuth” can be set true only if the “trustForIseAuth” has been set true. Certificate based admin authentication Use “trustForCertificateBasedAdminAuth”:true if the certificate is used for trust within Cisco ISE, such as for secure communication between Cisco ISE nodes Note: “trustForCertificateBasedAdminAuth” can be set true only if “trustForIseAuth” and “trustForClientAuth” are true. Authentication of Cisco Services Use “trustForCiscoServicesAuth”:true if the certificate is to be used for trusting external Cisco services, such as Feed Service. OCSP Configuration Usage Validation against OCSP service Use “enableOCSPValidation”:true to validate the certificate against OCSP service mentioned in the field selectedOCSPService OCSP Service name Use “selectedOCSPService”:”Name of OCSP Service” Name of the OCSP service against which the certificate should be validated Note: “selectedOCSPService” value is used if “enableOCSPValidation” has been set true. Reject the request if OCSP returns UNKNOWN status Use “rejectIfNoStatusFromOCSP”:true to reject the certificate if the OCSP service returns UNKNOWN status Note: “rejectIfNoStatusFromOCSP:true” can be used only if “enableOCSPValidation” has been set true. Reject the request if OCSP Responder is unreachable Use “rejectIfUnreachableFromOCSP”:true to reject the certificate if the OCSP service is unreachable. Note: “rejectIfUnreachableFromOCSP:true” can be used only if “enableOCSPValidation” has been set true. Certificate Revocation List Configuration Usage Validation against CRL Use “downloadCRL”:true to validate the certificate against CRL downloaded from URL mentioned in the field crlDistributionUrl CRL distribution url Use “crlDistributionUrl” to specify the URL from where the CRL should be downloaded Note: “crlDistributionUrl” value is used if “downloadCRL” has been set true. Retrieve CRL time Use “automaticCRLUpdate”:true and automaticCRLUpdatePeriod, automaticCRLUpdatePeriod to set the time before which CRL is automatically retrieved prior to expiration Use “nonAutomaticCRLUpdatePeriod, nonAutomaticCRLUpdateUnits to set the time period for CRL retrieval in loop. Note: All the above fields can be used only if “downloadCRL” has been set true. If download fails Use “crlDownloadFailureRetries” and “crlDownloadFailureRetriesUnits” to set retry time period if CRL download fails Note: “crlDownloadFailureRetries” and “crlDownloadFailureRetriesUnits” can be used only if “downloadCRL” has been set true. Enable Server Identity Check Use “enableServerIdentityCheck”:true to verify that HTTPS or LDAPS server certificate name fits the configured server URL Note: “enableServerIdentityCheck:true” can be used only if “downloadCRL” has been set true. Bypass CRL Verification if CRL is not Received Use “authenticateBeforeCRLReceived”:true to bypass CRL Verification if CRL is not Received Note: “authenticateBeforeCRLReceived:true” can be used only if “downloadCRL” has been set true. Ignore that CRL is not yet valid or has expired Use “ignoreCRLExpiration”:true to ignore if CRL is not yet valid or expired Note: “ignoreCRLExpiration:true” can be used only if “downloadCRL” has been set true. Note: boolean properties accept integers values as well, with 0 considered as false and other values being considered as true .
- Parameters
authenticate_before_crl_received (boolean) – Switch to enable or disable CRL verification if CRL is not received, property of the request body.
automatic_crl_update (boolean) – Switch to enable or disable automatic CRL update, property of the request body.
automatic_crl_update_period (integer) – Automatic CRL update period, property of the request body.
automatic_crl_update_units (string) – Unit of time for automatic CRL update, property of the request body. Available values are ‘Days’, ‘Hours’, ‘Minutes’ and ‘Weeks’.
crl_distribution_url (string) – CRL Distribution URL, property of the request body.
crl_download_failure_retries (integer) – If CRL download fails, wait time before retry, property of the request body.
crl_download_failure_retries_units (string) – Unit of time before retry if CRL download fails, property of the request body. Available values are ‘Days’, ‘Hours’, ‘Minutes’ and ‘Weeks’.
description (string) – Description for trust certificate, property of the request body.
download_crl (boolean) – Switch to enable or disable download of CRL, property of the request body.
enable_ocsp_validation (boolean) – Switch to enable or disable OCSP Validation, property of the request body.
enable_server_identity_check (boolean) – Switch to enable or disable verification if HTTPS or LDAP server certificate name fits the configured server URL, property of the request body.
ignore_crl_expiration (boolean) – Switch to enable or disable ignore CRL expiration, property of the request body.
name (string) – Friendly name of the certificate, property of the request body.
non_automatic_crl_update_period (integer) – Non automatic CRL update period, property of the request body.
non_automatic_crl_update_units (string) – Unit of time of non automatic CRL update, property of the request body. Available values are ‘Days’, ‘Hours’, ‘Minutes’ and ‘Weeks’.
reject_if_no_status_from_ocs_p (boolean) – Switch to reject certificate if there is no status from OCSP, property of the request body.
reject_if_unreachable_from_ocs_p (boolean) – Switch to reject certificate if unreachable from OCSP, property of the request body.
selected_ocsp_service (string) – Name of selected OCSP Service, property of the request body.
status (string) – status, property of the request body. Available values are ‘Disabled’ and ‘Enabled’.
trust_for_certificate_based_admin_auth (boolean) – Trust for Certificate based Admin authentication, property of the request body.
trust_for_cisco_services_auth (boolean) – Trust for authentication of Cisco Services, property of the request body.
trust_for_client_auth (boolean) – Trust for client authentication and Syslog, property of the request body.
trust_for_ise_auth (boolean) – Trust for authentication within Cisco ISE, property of the request body.
id (basestring) – id path parameter. ID of the trust certificate.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_trusted_certificate_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes a Trust Certificate from Trusted Certificate Store based on a given ID.
- Parameters
id (basestring) – id path parameter. ID of the Trusted Certificate to be deleted.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
clear_threats_and_vulnerabilities¶
-
class
ClearThreatsAndVulnerabilities
[source]¶ Identity Services Engine ClearThreatsAndVulnerabilities API (version: 3.1.1).
Wraps the Identity Services Engine ClearThreatsAndVulnerabilities API and exposes the API as native Python methods that return native Python objects.
Clear Threats and Vulnerabilities API allows the user to delete the ThreatContext and Threat events that are associated with the given MAC Address.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.1
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Example Values
name
String
Yes
Resource Name
id
String
Yes
Resource UUID value
macAddresses
String
Yes
One or more endpoint MAC addresses
[ “00:00:00:00:00:F2”, “00:00:00:00:00:F3” ]
-
clear_threats_and_vulnerabilities
(mac_addresses=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to delete the ThreatContext and Threat events that are associated with the given MAC Address.
- Parameters
mac_addresses (string) – macAddresses, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
clear
(mac_addresses=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for clear_threats_and_vulnerabilities
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the clear threats and vulneribilities.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
consumer¶
-
class
Consumer
[source]¶ Identity Services Engine Consumer API (version: 3.1.1).
Wraps the Identity Services Engine Consumer API and exposes the API as native Python methods that return native Python objects.
# Cisco ISE 3.0 pxGrid REST APIs
## License [Cisco Sample Code License](https://developer.cisco.com/site/license/cisco-sample-code-license/)
## Status These are the status icons for the requests so far. - ⌗ : must create resources to test - 🚧 : incomplete | untested - 🛑 : unsupported | bug
## Environment Variables This collection uses environment variables in scripts in the Tests tab to store data (id, name, portalId, etc.) between requests. This allows you to GET or POST then immediately GET {id} on a resource. Using No Environment will cause this convenience functionality to fail so be sure to choose one.
## Collection Variables This collection includes some default variables that you will want to update or override with environment variables for your ISE deployment. Specifically, you will want to set: - ise_pxg: the ISE PAN node name or IP address. Default: ise.securitydemo.net - rest_username: the username for ERS API access. Must be a member of SuperAdmin, ERSAdmin or ERSOperator groups. Default: admin which is the ISE SuperAdmin - rest_password: Default: C1sco12345
-
create_account
(node_name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ 🚧 AccountCreate.
- Parameters
node_name (string) – nodeName, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(node_name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_account
-
activate_account
(description=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ 🚧 AccountActivate.
- Parameters
description (string) – description, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
lookup_service
(name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ 🚧 ServiceLookup.
- Parameters
name (string) – name, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
access_secret
(peer_node_name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ 🚧 AccessSecret.
- Parameters
peer_node_name (string) – peerNodeName, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
device_administration_authentication_rules¶
-
class
DeviceAdministrationAuthenticationRules
[source]¶ Identity Services Engine Device Administration - Authentication Rules API (version: 3.1.1).
Wraps the Identity Services Engine Device Administration - Authentication Rules API and exposes the API as native Python methods that return native Python objects.
-
get_device_admin_authentication_rules
(policy_id, headers=None, **query_parameters)[source]¶ Device Admin Get authentication rules.
- Parameters
policy_id (basestring) – policyId path parameter. Policy id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(policy_id, headers=None, **query_parameters)[source]¶ Alias for get_device_admin_authentication_rules
-
create_device_admin_authentication_rule
(policy_id, identity_source_name=None, if_auth_fail=None, if_process_fail=None, if_user_not_found=None, link=None, rule=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Device Admin Create authentication rule: Rule must include name and condition. Condition has hierarchical structure which define a set of conditions for which authentication policy rule could be match. Condition can be either reference to a stored Library condition, using model ConditionReference or dynamically built conditions which are not stored in the conditions Library, using models ConditionAttributes, ConditionAndBlock, ConditionOrBlock . .
- Parameters
identity_source_name (string) – Identity source name from the identity stores, property of the request body.
if_auth_fail (string) – Action to perform when authentication fails such as Bad credentials, disabled user and so on, property of the request body.
if_process_fail (string) – Action to perform when ISE is uanble to access the identity database, property of the request body.
if_user_not_found (string) – Action to perform when user is not found in any of identity stores, property of the request body.
link (object) – link, property of the request body.
rule (object) – Common attributes in rule authentication/authorization, property of the request body.
policy_id (basestring) – policyId path parameter. Policy id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(policy_id, identity_source_name=None, if_auth_fail=None, if_process_fail=None, if_user_not_found=None, link=None, rule=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_device_admin_authentication_rule
-
reset_hit_counts_device_admin_authentication_rules
(policy_id, headers=None, **query_parameters)[source]¶ Device Admin Reset HitCount for Authentication Rules.
- Parameters
policy_id (basestring) – policyId path parameter. Policy id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
reset_hit_counts_by_id
(policy_id, headers=None, **query_parameters)[source]¶ Alias for reset_hit_counts_device_admin_authentication_rules
-
get_device_admin_authentication_rule_by_id
(id, policy_id, headers=None, **query_parameters)[source]¶ Device Admin Get rule attributes.
- Parameters
policy_id (basestring) – policyId path parameter. Policy id.
id (basestring) – id path parameter. Rule id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_device_admin_authentication_rule_by_id
(id, policy_id, identity_source_name=None, if_auth_fail=None, if_process_fail=None, if_user_not_found=None, link=None, rule=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Device Admin Update rule.
- Parameters
identity_source_name (string) – Identity source name from the identity stores, property of the request body.
if_auth_fail (string) – Action to perform when authentication fails such as Bad credentials, disabled user and so on, property of the request body.
if_process_fail (string) – Action to perform when ISE is uanble to access the identity database, property of the request body.
if_user_not_found (string) – Action to perform when user is not found in any of identity stores, property of the request body.
link (object) – link, property of the request body.
rule (object) – Common attributes in rule authentication/authorization, property of the request body.
policy_id (basestring) – policyId path parameter. Policy id.
id (basestring) – id path parameter. Rule id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, policy_id, identity_source_name=None, if_auth_fail=None, if_process_fail=None, if_user_not_found=None, link=None, rule=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
-
delete_device_admin_authentication_rule_by_id
(id, policy_id, headers=None, **query_parameters)[source]¶ Device Admin Delete rule.
- Parameters
policy_id (basestring) – policyId path parameter. Policy id.
id (basestring) – id path parameter. Rule id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
device_administration_command_set¶
-
class
DeviceAdministrationCommandSet
[source]¶ Identity Services Engine Device Administration - Command Set API (version: 3.1.1).
Wraps the Identity Services Engine Device Administration - Command Set API and exposes the API as native Python methods that return native Python objects.
-
get_device_admin_command_sets
(headers=None, **query_parameters)[source]¶ Device Admin Return list of command sets. (Other CRUD APIs available through ERS).
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(list): A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(headers=None, **query_parameters)[source]¶ Alias for get_device_admin_command_sets
-
device_administration_conditions¶
-
class
DeviceAdministrationConditions
[source]¶ Identity Services Engine Device Administration - Conditions API (version: 3.1.1).
Wraps the Identity Services Engine Device Administration - Conditions API and exposes the API as native Python methods that return native Python objects.
-
get_device_admin_conditions
(headers=None, **query_parameters)[source]¶ Device Admin Returns list of library conditions.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(headers=None, **query_parameters)[source]¶ Alias for get_device_admin_conditions
-
create_device_admin_condition
(attribute_name=None, attribute_value=None, children=None, condition_type=None, dates_range=None, dates_range_exception=None, description=None, dictionary_name=None, dictionary_value=None, hours_range=None, hours_range_exception=None, id=None, is_negate=None, link=None, name=None, operator=None, week_days=None, week_days_exception=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Device Admin Creates a library condition: Library Condition has hierarchical structure which define a set of condition for which authentication and authorization policy rules could be match. Condition can be compose from single dictionary attribute name and value using model LibraryConditionAttributes , or from combination of dictionary attributes with logical operation of AND/OR between them, using models: LibraryConditionAndBlock or LibraryConditionOrBlock . When using AND/OR blocks, the condition will include inner layers inside these blocks, these layers are built using the inner condition models: ConditionAttributes , ConditionAndBlock , ConditionOrBlock , that represent dynamically built Conditions which are not stored in the conditions Library, or using ConditionReference , which includes an ID to existing stored condition in the library. The LibraryCondition models can only be used in the outer-most layer (root of the condition) and must always include the condition name. When using one of the 3 inner condition models ( ConditionAttributes, ConditionAndBlock, ConditionOrBlock ), condition name cannot be included in the request, since these will not be stored in the conditions library, and used only as inner members of the root condition. When using ConditionReference model in inner layers, the condition name is not required. ConditionReference objects can also include a reference ID to a condition of type TimeAndDate . .
- Parameters
attribute_name (string) – Dictionary attribute name, property of the request body.
attribute_value (string) – Attribute value for condition Value type is specified in dictionary object if multiple values allowed is specified in dictionary object, property of the request body.
children (list) – In case type is andBlock or orBlock addtional conditions will be aggregated under this logical (OR/AND) condition, property of the request body (list of objects).
condition_type (string) – Inidicates whether the record is the condition itself(data) or a logical(or,and) aggregation Data type enum(reference,single) indicates than “conditonId” OR “ConditionAttrs” fields should contain condition data but not both Logical aggreation(and,or) enum indicates that additional conditions are present under the children field, property of the request body. Available values are ‘ConditionAndBlock’, ‘ConditionAttributes’, ‘ConditionOrBlock’, ‘ConditionReference’, ‘LibraryConditionAndBlock’, ‘LibraryConditionAttributes’, ‘LibraryConditionOrBlock’ and ‘TimeAndDateCondition’.
dates_range (object) – Defines for which date/s TimeAndDate condition will be matched Options are Date range, for specific date, the same date should be used for start/end date Default no specific dates In order to reset the dates to have no specific dates Date format yyyy- mm-dd (MM = month, dd = day, yyyy = year), property of the request body.
dates_range_exception (object) – Defines for which date/s TimeAndDate condition will be matched Options are Date range, for specific date, the same date should be used for start/end date Default no specific dates In order to reset the dates to have no specific dates Date format yyyy- mm-dd (MM = month, dd = day, yyyy = year), property of the request body.
description (string) – Condition description, property of the request body.
dictionary_name (string) – Dictionary name, property of the request body.
dictionary_value (string) – Dictionary value, property of the request body.
hours_range (object) – Defines for which hours a TimeAndDate condition will be matched Time format hh:mm ( h = hour , mm = minutes ) Default All Day , property of the request body.
hours_range_exception (object) – Defines for which hours a TimeAndDate condition will be matched Time format hh:mm ( h = hour , mm = minutes ) Default All Day , property of the request body.
id (string) – id, property of the request body.
is_negate (boolean) – Indicates whereas this condition is in negate mode, property of the request body.
link (object) – link, property of the request body.
name (string) – Condition name, property of the request body.
operator (string) – Equality operator, property of the request body. Available values are ‘contains’, ‘endsWith’, ‘equals’, ‘greaterOrEquals’, ‘greaterThan’, ‘in’, ‘ipEquals’, ‘ipGreaterThan’, ‘ipLessThan’, ‘ipNotEquals’, ‘lessOrEquals’, ‘lessThan’, ‘matches’, ‘notContains’, ‘notEndsWith’, ‘notEquals’, ‘notIn’, ‘notStartsWith’ and ‘startsWith’.
week_days (list) – Defines for which days this condition will be matched Days format Arrays of WeekDay enums Default List of All week days, property of the request body (list of strings. Available values are ‘Friday’, ‘Monday’, ‘Saturday’, ‘Sunday’, ‘Thursday’, ‘Tuesday’ and ‘Wednesday’).
week_days_exception (list) – Defines for which days this condition will NOT be matched Days format Arrays of WeekDay enums Default Not enabled, property of the request body (list of strings. Available values are ‘Friday’, ‘Monday’, ‘Saturday’, ‘Sunday’, ‘Thursday’, ‘Tuesday’ and ‘Wednesday’).
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(attribute_name=None, attribute_value=None, children=None, condition_type=None, dates_range=None, dates_range_exception=None, description=None, dictionary_name=None, dictionary_value=None, hours_range=None, hours_range_exception=None, id=None, is_negate=None, link=None, name=None, operator=None, week_days=None, week_days_exception=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_device_admin_condition
-
get_device_admin_conditions_for_authentication_rules
(headers=None, **query_parameters)[source]¶ Device Admin Returns list of library conditions for authentication rules.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_authentication_rules
(headers=None, **query_parameters)[source]¶ Alias for get_device_admin_conditions_for_authentication_rules
Device Admin Returns list of library conditions for authorization rules.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_device_admin_condition_by_name
(name, headers=None, **query_parameters)[source]¶ Device Admin Returns a library condition.
- Parameters
name (basestring) – name path parameter. Condition name.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_name
(name, headers=None, **query_parameters)[source]¶ Alias for get_device_admin_condition_by_name
-
update_device_admin_condition_by_name
(name, attribute_name=None, attribute_value=None, children=None, condition_type=None, dates_range=None, dates_range_exception=None, description=None, dictionary_name=None, dictionary_value=None, hours_range=None, hours_range_exception=None, id=None, is_negate=None, link=None, operator=None, week_days=None, week_days_exception=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Device Admin Update library condition using condition name.
- Parameters
attribute_name (string) – Dictionary attribute name, property of the request body.
attribute_value (string) – Attribute value for condition Value type is specified in dictionary object if multiple values allowed is specified in dictionary object, property of the request body.
children (list) – In case type is andBlock or orBlock addtional conditions will be aggregated under this logical (OR/AND) condition, property of the request body (list of objects).
condition_type (string) – Inidicates whether the record is the condition itself(data) or a logical(or,and) aggregation Data type enum(reference,single) indicates than “conditonId” OR “ConditionAttrs” fields should contain condition data but not both Logical aggreation(and,or) enum indicates that additional conditions are present under the children field, property of the request body. Available values are ‘ConditionAndBlock’, ‘ConditionAttributes’, ‘ConditionOrBlock’, ‘ConditionReference’, ‘LibraryConditionAndBlock’, ‘LibraryConditionAttributes’, ‘LibraryConditionOrBlock’ and ‘TimeAndDateCondition’.
dates_range (object) – Defines for which date/s TimeAndDate condition will be matched Options are Date range, for specific date, the same date should be used for start/end date Default no specific dates In order to reset the dates to have no specific dates Date format yyyy- mm-dd (MM = month, dd = day, yyyy = year), property of the request body.
dates_range_exception (object) – Defines for which date/s TimeAndDate condition will be matched Options are Date range, for specific date, the same date should be used for start/end date Default no specific dates In order to reset the dates to have no specific dates Date format yyyy- mm-dd (MM = month, dd = day, yyyy = year), property of the request body.
description (string) – Condition description, property of the request body.
dictionary_name (string) – Dictionary name, property of the request body.
dictionary_value (string) – Dictionary value, property of the request body.
hours_range (object) – Defines for which hours a TimeAndDate condition will be matched Time format hh:mm ( h = hour , mm = minutes ) Default All Day , property of the request body.
hours_range_exception (object) – Defines for which hours a TimeAndDate condition will be matched Time format hh:mm ( h = hour , mm = minutes ) Default All Day , property of the request body.
id (string) – id, property of the request body.
is_negate (boolean) – Indicates whereas this condition is in negate mode, property of the request body.
link (object) – link, property of the request body.
name (basestring) – Condition name, property of the request body.
operator (string) – Equality operator, property of the request body. Available values are ‘contains’, ‘endsWith’, ‘equals’, ‘greaterOrEquals’, ‘greaterThan’, ‘in’, ‘ipEquals’, ‘ipGreaterThan’, ‘ipLessThan’, ‘ipNotEquals’, ‘lessOrEquals’, ‘lessThan’, ‘matches’, ‘notContains’, ‘notEndsWith’, ‘notEquals’, ‘notIn’, ‘notStartsWith’ and ‘startsWith’.
week_days (list) – Defines for which days this condition will be matched Days format Arrays of WeekDay enums Default List of All week days, property of the request body (list of strings. Available values are ‘Friday’, ‘Monday’, ‘Saturday’, ‘Sunday’, ‘Thursday’, ‘Tuesday’ and ‘Wednesday’).
week_days_exception (list) – Defines for which days this condition will NOT be matched Days format Arrays of WeekDay enums Default Not enabled, property of the request body (list of strings. Available values are ‘Friday’, ‘Monday’, ‘Saturday’, ‘Sunday’, ‘Thursday’, ‘Tuesday’ and ‘Wednesday’).
name – name path parameter. Condition name.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_name
(name, attribute_name=None, attribute_value=None, children=None, condition_type=None, dates_range=None, dates_range_exception=None, description=None, dictionary_name=None, dictionary_value=None, hours_range=None, hours_range_exception=None, id=None, is_negate=None, link=None, operator=None, week_days=None, week_days_exception=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_device_admin_condition_by_name
-
delete_device_admin_condition_by_name
(name, headers=None, **query_parameters)[source]¶ NDevice Admin Delete a library condition using condition Name.
- Parameters
name (basestring) – name path parameter. Condition name.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_name
(name, headers=None, **query_parameters)[source]¶ Alias for delete_device_admin_condition_by_name
-
get_device_admin_conditions_for_policy_sets
(headers=None, **query_parameters)[source]¶ Device Admin Returns list of library conditions for policy sets.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_device_admin_condition_by_id
(id, headers=None, **query_parameters)[source]¶ Device Admin Returns a library condition.
- Parameters
id (basestring) – id path parameter. Condition id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_device_admin_condition_by_id
-
update_device_admin_condition_by_id
(id, attribute_name=None, attribute_value=None, children=None, condition_type=None, dates_range=None, dates_range_exception=None, description=None, dictionary_name=None, dictionary_value=None, hours_range=None, hours_range_exception=None, is_negate=None, link=None, name=None, operator=None, week_days=None, week_days_exception=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Device Admin Update library condition.
- Parameters
attribute_name (string) – Dictionary attribute name, property of the request body.
attribute_value (string) – Attribute value for condition Value type is specified in dictionary object if multiple values allowed is specified in dictionary object, property of the request body.
children (list) – In case type is andBlock or orBlock addtional conditions will be aggregated under this logical (OR/AND) condition, property of the request body (list of objects).
condition_type (string) – Inidicates whether the record is the condition itself(data) or a logical(or,and) aggregation Data type enum(reference,single) indicates than “conditonId” OR “ConditionAttrs” fields should contain condition data but not both Logical aggreation(and,or) enum indicates that additional conditions are present under the children field, property of the request body. Available values are ‘ConditionAndBlock’, ‘ConditionAttributes’, ‘ConditionOrBlock’, ‘ConditionReference’, ‘LibraryConditionAndBlock’, ‘LibraryConditionAttributes’, ‘LibraryConditionOrBlock’ and ‘TimeAndDateCondition’.
dates_range (object) – Defines for which date/s TimeAndDate condition will be matched Options are Date range, for specific date, the same date should be used for start/end date Default no specific dates In order to reset the dates to have no specific dates Date format yyyy- mm-dd (MM = month, dd = day, yyyy = year), property of the request body.
dates_range_exception (object) – Defines for which date/s TimeAndDate condition will be matched Options are Date range, for specific date, the same date should be used for start/end date Default no specific dates In order to reset the dates to have no specific dates Date format yyyy- mm-dd (MM = month, dd = day, yyyy = year), property of the request body.
description (string) – Condition description, property of the request body.
dictionary_name (string) – Dictionary name, property of the request body.
dictionary_value (string) – Dictionary value, property of the request body.
hours_range (object) – Defines for which hours a TimeAndDate condition will be matched Time format hh:mm ( h = hour , mm = minutes ) Default All Day , property of the request body.
hours_range_exception (object) – Defines for which hours a TimeAndDate condition will be matched Time format hh:mm ( h = hour , mm = minutes ) Default All Day , property of the request body.
id (basestring) – id, property of the request body.
is_negate (boolean) – Indicates whereas this condition is in negate mode, property of the request body.
link (object) – link, property of the request body.
name (string) – Condition name, property of the request body.
operator (string) – Equality operator, property of the request body. Available values are ‘contains’, ‘endsWith’, ‘equals’, ‘greaterOrEquals’, ‘greaterThan’, ‘in’, ‘ipEquals’, ‘ipGreaterThan’, ‘ipLessThan’, ‘ipNotEquals’, ‘lessOrEquals’, ‘lessThan’, ‘matches’, ‘notContains’, ‘notEndsWith’, ‘notEquals’, ‘notIn’, ‘notStartsWith’ and ‘startsWith’.
week_days (list) – Defines for which days this condition will be matched Days format Arrays of WeekDay enums Default List of All week days, property of the request body (list of strings. Available values are ‘Friday’, ‘Monday’, ‘Saturday’, ‘Sunday’, ‘Thursday’, ‘Tuesday’ and ‘Wednesday’).
week_days_exception (list) – Defines for which days this condition will NOT be matched Days format Arrays of WeekDay enums Default Not enabled, property of the request body (list of strings. Available values are ‘Friday’, ‘Monday’, ‘Saturday’, ‘Sunday’, ‘Thursday’, ‘Tuesday’ and ‘Wednesday’).
id – id path parameter. Condition id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, attribute_name=None, attribute_value=None, children=None, condition_type=None, dates_range=None, dates_range_exception=None, description=None, dictionary_name=None, dictionary_value=None, hours_range=None, hours_range_exception=None, is_negate=None, link=None, name=None, operator=None, week_days=None, week_days_exception=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_device_admin_condition_by_id
-
delete_device_admin_condition_by_id
(id, headers=None, **query_parameters)[source]¶ Device Admin Delete a library condition.
- Parameters
id (basestring) – id path parameter. Condition id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_device_admin_condition_by_id
-
device_administration_dictionary_attributes_list¶
-
class
DeviceAdministrationDictionaryAttributesList
[source]¶ Identity Services Engine Device Administration - Dictionary Attributes List API (version: 3.1.1).
Wraps the Identity Services Engine Device Administration - Dictionary Attributes List API and exposes the API as native Python methods that return native Python objects.
-
get_device_admin_dictionaries_authentication
(headers=None, **query_parameters)[source]¶ Network Access Returns list of dictionary attributes for authentication.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
Network Access Returns list of dictionary attributes for authorization.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_device_admin_dictionaries_policy_set
(headers=None, **query_parameters)[source]¶ Network Access Returns list of dictionary attributes for policyset.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_policy_set
(headers=None, **query_parameters)[source]¶ Alias for get_device_admin_dictionaries_policy_set
-
device_administration_identity_stores¶
-
class
DeviceAdministrationIdentityStores
[source]¶ Identity Services Engine Device Administration - Identity Stores API (version: 3.1.1).
Wraps the Identity Services Engine Device Administration - Identity Stores API and exposes the API as native Python methods that return native Python objects.
-
get_device_admin_identity_stores
(headers=None, **query_parameters)[source]¶ Device Admin Return list of identity stores for authentication. (Other CRUD APIs available through ERS).
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(list): A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(headers=None, **query_parameters)[source]¶ Alias for get_device_admin_identity_stores
-
device_administration_network_conditions¶
-
class
DeviceAdministrationNetworkConditions
[source]¶ Identity Services Engine Device Administration - Network Conditions API (version: 3.1.1).
Wraps the Identity Services Engine Device Administration - Network Conditions API and exposes the API as native Python methods that return native Python objects.
-
get_device_admin_network_conditions
(headers=None, **query_parameters)[source]¶ Device Admin Returns a list of network conditions.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(headers=None, **query_parameters)[source]¶ Alias for get_device_admin_network_conditions
-
create_device_admin_network_condition
(condition_type=None, conditions=None, description=None, id=None, link=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Device AdminCreates network condition.
- Parameters
condition_type (string) – This field determines the content of the conditions field, property of the request body. Available values are ‘DeviceCondition’, ‘DevicePortCondition’ and ‘EndstationCondition’.
conditions (list) – conditions, property of the request body (list of objects).
description (string) – description, property of the request body.
id (string) – id, property of the request body.
link (object) – link, property of the request body.
name (string) – Network Condition name, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(condition_type=None, conditions=None, description=None, id=None, link=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_device_admin_network_condition
-
get_device_admin_network_condition_by_id
(id, headers=None, **query_parameters)[source]¶ Device Admin Returns a network condition.
- Parameters
id (basestring) – id path parameter. Condition id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_device_admin_network_condition_by_id
-
update_device_admin_network_condition_by_id
(id, condition_type=None, conditions=None, description=None, link=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Device Admin Update network condition.
- Parameters
condition_type (string) – This field determines the content of the conditions field, property of the request body. Available values are ‘DeviceCondition’, ‘DevicePortCondition’ and ‘EndstationCondition’.
conditions (list) – conditions, property of the request body (list of objects).
description (string) – description, property of the request body.
id (basestring) – id, property of the request body.
link (object) – link, property of the request body.
name (string) – Network Condition name, property of the request body.
id – id path parameter. Condition id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, condition_type=None, conditions=None, description=None, link=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
-
delete_device_admin_network_condition_by_id
(id, headers=None, **query_parameters)[source]¶ Device Admin Delete network condition.
- Parameters
id (basestring) – id path parameter. Condition id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
device_administration_policy_set¶
-
class
DeviceAdministrationPolicySet
[source]¶ Identity Services Engine Device Administration - Policy Set API (version: 3.1.1).
Wraps the Identity Services Engine Device Administration - Policy Set API and exposes the API as native Python methods that return native Python objects.
-
get_device_admin_policy_sets
(headers=None, **query_parameters)[source]¶ Device Admin List of policy sets.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(headers=None, **query_parameters)[source]¶ Alias for get_device_admin_policy_sets
-
create_device_admin_policy_set
(condition=None, default=None, description=None, hit_counts=None, id=None, is_proxy=None, link=None, name=None, rank=None, service_name=None, state=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Device Admin Create a new policy set: Policy must include name , service identifier (either server sequence or allowed protocol) and a condition. Condition has hierarchical structure which define a set of condition for which policy could be match. Condition can be either reference to a stored Library condition, using model ConditionReference , or, dynamically built conditions which are not stored in the conditions Library, using models ConditionAttributes, ConditionAndBlock, ConditionOrBlock . .
- Parameters
condition (object) – condition, property of the request body.
default (boolean) – Flag which indicates if this policy set is the default one, property of the request body.
description (string) – The description for the policy set, property of the request body.
hit_counts (integer) – The amount of times the policy was matched, property of the request body.
id (string) – Identifier for the policy set, property of the request body.
is_proxy (boolean) – Flag which indicates if the policy set service is of type ‘Proxy Sequence’ or ‘Allowed Protocols’, property of the request body.
link (object) – link, property of the request body.
name (string) – Given name for the policy set, [Valid characters are alphanumerics, underscore, hyphen, space, period, parentheses], property of the request body.
rank (integer) – The rank(priority) in relation to other policy set. Lower rank is higher priority., property of the request body.
service_name (string) – Policy set service identifier Allowed Protocols,Server Sequence.., property of the request body.
state (string) – The state that the policy set is in. A disabled policy set cannot be matched., property of the request body. Available values are ‘disabled’, ‘enabled’ and ‘monitor’.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(condition=None, default=None, description=None, hit_counts=None, id=None, is_proxy=None, link=None, name=None, rank=None, service_name=None, state=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_device_admin_policy_set
-
reset_hit_counts_device_admin_policy_sets
(headers=None, **query_parameters)[source]¶ Device Admin Reset HitCount for PolicySets.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_device_admin_policy_set_by_id
(id, headers=None, **query_parameters)[source]¶ Device Admin Get policy set attributes.
- Parameters
id (basestring) – id path parameter. Policy id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_device_admin_policy_set_by_id
-
update_device_admin_policy_set_by_id
(id, condition=None, default=None, description=None, hit_counts=None, is_proxy=None, link=None, name=None, rank=None, service_name=None, state=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Device Admin Update a policy set.
- Parameters
condition (object) – condition, property of the request body.
default (boolean) – Flag which indicates if this policy set is the default one, property of the request body.
description (string) – The description for the policy set, property of the request body.
hit_counts (integer) – The amount of times the policy was matched, property of the request body.
id (basestring) – Identifier for the policy set, property of the request body.
is_proxy (boolean) – Flag which indicates if the policy set service is of type ‘Proxy Sequence’ or ‘Allowed Protocols’, property of the request body.
link (object) – link, property of the request body.
name (string) – Given name for the policy set, [Valid characters are alphanumerics, underscore, hyphen, space, period, parentheses], property of the request body.
rank (integer) – The rank(priority) in relation to other policy set. Lower rank is higher priority., property of the request body.
service_name (string) – Policy set service identifier Allowed Protocols,Server Sequence.., property of the request body.
state (string) – The state that the policy set is in. A disabled policy set cannot be matched., property of the request body. Available values are ‘disabled’, ‘enabled’ and ‘monitor’.
id – id path parameter. Policy id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, condition=None, default=None, description=None, hit_counts=None, is_proxy=None, link=None, name=None, rank=None, service_name=None, state=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_device_admin_policy_set_by_id
-
delete_device_admin_policy_set_by_id
(id, headers=None, **query_parameters)[source]¶ Device Admin Delete a policy set.
- Parameters
id (basestring) – id path parameter. Policy id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_device_admin_policy_set_by_id
-
device_administration_profiles¶
-
class
DeviceAdministrationProfiles
[source]¶ Identity Services Engine Device Administration - Profiles API (version: 3.1.1).
Wraps the Identity Services Engine Device Administration - Profiles API and exposes the API as native Python methods that return native Python objects.
-
get_device_admin_profiles
(headers=None, **query_parameters)[source]¶ Device Admin Returns list of shell profiles. (Other CRUD APIs available through ERS).
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(list): A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(headers=None, **query_parameters)[source]¶ Alias for get_device_admin_profiles
-
device_administration_service_names¶
-
class
DeviceAdministrationServiceNames
[source]¶ Identity Services Engine Device Administration - Service Names API (version: 3.1.1).
Wraps the Identity Services Engine Device Administration - Service Names API and exposes the API as native Python methods that return native Python objects.
-
get_device_admin_service_names
(headers=None, **query_parameters)[source]¶ Returns list of Allowed Protocols and Server Sequences for Device Admin Policy Set results. ‘isLocalAuthorization’ property is available only for Network Access Policy Set results of type Server Sequence. (Other CRUD APIs available through ERS).
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(list): A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(headers=None, **query_parameters)[source]¶ Alias for get_device_admin_service_names
-
device_administration_time_date_conditions¶
-
class
DeviceAdministrationTimeDateConditions
[source]¶ Identity Services Engine Device Administration - Time/Date Conditions API (version: 3.1.1).
Wraps the Identity Services Engine Device Administration - Time/Date Conditions API and exposes the API as native Python methods that return native Python objects.
-
get_device_admin_time_conditions
(headers=None, **query_parameters)[source]¶ Device Admin Returns a list of time and date conditions.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(headers=None, **query_parameters)[source]¶ Alias for get_device_admin_time_conditions
-
create_device_admin_time_condition
(attribute_name=None, attribute_value=None, children=None, condition_type=None, dates_range=None, dates_range_exception=None, description=None, dictionary_name=None, dictionary_value=None, hours_range=None, hours_range_exception=None, id=None, is_negate=None, link=None, name=None, operator=None, week_days=None, week_days_exception=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Device Admin Creates time/date condition.
- Parameters
attribute_name (string) – Dictionary attribute name, property of the request body.
attribute_value (string) – Attribute value for condition Value type is specified in dictionary object if multiple values allowed is specified in dictionary object, property of the request body.
children (list) – In case type is andBlock or orBlock addtional conditions will be aggregated under this logical (OR/AND) condition, property of the request body (list of objects).
condition_type (string) – Inidicates whether the record is the condition itself(data) or a logical(or,and) aggregation Data type enum(reference,single) indicates than “conditonId” OR “ConditionAttrs” fields should contain condition data but not both Logical aggreation(and,or) enum indicates that additional conditions are present under the children field, property of the request body. Available values are ‘ConditionAndBlock’, ‘ConditionAttributes’, ‘ConditionOrBlock’, ‘ConditionReference’, ‘LibraryConditionAndBlock’, ‘LibraryConditionAttributes’, ‘LibraryConditionOrBlock’ and ‘TimeAndDateCondition’.
dates_range (object) – Defines for which date/s TimeAndDate condition will be matched Options are Date range, for specific date, the same date should be used for start/end date Default no specific dates In order to reset the dates to have no specific dates Date format yyyy- mm-dd (MM = month, dd = day, yyyy = year), property of the request body.
dates_range_exception (object) – Defines for which date/s TimeAndDate condition will be matched Options are Date range, for specific date, the same date should be used for start/end date Default no specific dates In order to reset the dates to have no specific dates Date format yyyy- mm-dd (MM = month, dd = day, yyyy = year), property of the request body.
description (string) – Condition description, property of the request body.
dictionary_name (string) – Dictionary name, property of the request body.
dictionary_value (string) – Dictionary value, property of the request body.
hours_range (object) – Defines for which hours a TimeAndDate condition will be matched Time format hh:mm ( h = hour , mm = minutes ) Default All Day , property of the request body.
hours_range_exception (object) – Defines for which hours a TimeAndDate condition will be matched Time format hh:mm ( h = hour , mm = minutes ) Default All Day , property of the request body.
id (string) – id, property of the request body.
is_negate (boolean) – Indicates whereas this condition is in negate mode, property of the request body.
link (object) – link, property of the request body.
name (string) – Condition name, property of the request body.
operator (string) – Equality operator, property of the request body. Available values are ‘contains’, ‘endsWith’, ‘equals’, ‘greaterOrEquals’, ‘greaterThan’, ‘in’, ‘ipEquals’, ‘ipGreaterThan’, ‘ipLessThan’, ‘ipNotEquals’, ‘lessOrEquals’, ‘lessThan’, ‘matches’, ‘notContains’, ‘notEndsWith’, ‘notEquals’, ‘notIn’, ‘notStartsWith’ and ‘startsWith’.
week_days (list) – Defines for which days this condition will be matched Days format Arrays of WeekDay enums Default List of All week days, property of the request body (list of strings. Available values are ‘Friday’, ‘Monday’, ‘Saturday’, ‘Sunday’, ‘Thursday’, ‘Tuesday’ and ‘Wednesday’).
week_days_exception (list) – Defines for which days this condition will NOT be matched Days format Arrays of WeekDay enums Default Not enabled, property of the request body (list of strings. Available values are ‘Friday’, ‘Monday’, ‘Saturday’, ‘Sunday’, ‘Thursday’, ‘Tuesday’ and ‘Wednesday’).
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(attribute_name=None, attribute_value=None, children=None, condition_type=None, dates_range=None, dates_range_exception=None, description=None, dictionary_name=None, dictionary_value=None, hours_range=None, hours_range_exception=None, id=None, is_negate=None, link=None, name=None, operator=None, week_days=None, week_days_exception=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_device_admin_time_condition
-
get_device_admin_time_condition_by_id
(id, headers=None, **query_parameters)[source]¶ Device Admin Returns a network condition.
- Parameters
id (basestring) – id path parameter. Condition id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_device_admin_time_condition_by_id
-
update_device_admin_time_condition_by_id
(id, attribute_name=None, attribute_value=None, children=None, condition_type=None, dates_range=None, dates_range_exception=None, description=None, dictionary_name=None, dictionary_value=None, hours_range=None, hours_range_exception=None, is_negate=None, link=None, name=None, operator=None, week_days=None, week_days_exception=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Device Admin Update network condition.
- Parameters
attribute_name (string) – Dictionary attribute name, property of the request body.
attribute_value (string) – Attribute value for condition Value type is specified in dictionary object if multiple values allowed is specified in dictionary object, property of the request body.
children (list) – In case type is andBlock or orBlock addtional conditions will be aggregated under this logical (OR/AND) condition, property of the request body (list of objects).
condition_type (string) – Inidicates whether the record is the condition itself(data) or a logical(or,and) aggregation Data type enum(reference,single) indicates than “conditonId” OR “ConditionAttrs” fields should contain condition data but not both Logical aggreation(and,or) enum indicates that additional conditions are present under the children field, property of the request body. Available values are ‘ConditionAndBlock’, ‘ConditionAttributes’, ‘ConditionOrBlock’, ‘ConditionReference’, ‘LibraryConditionAndBlock’, ‘LibraryConditionAttributes’, ‘LibraryConditionOrBlock’ and ‘TimeAndDateCondition’.
dates_range (object) – Defines for which date/s TimeAndDate condition will be matched Options are Date range, for specific date, the same date should be used for start/end date Default no specific dates In order to reset the dates to have no specific dates Date format yyyy- mm-dd (MM = month, dd = day, yyyy = year), property of the request body.
dates_range_exception (object) – Defines for which date/s TimeAndDate condition will be matched Options are Date range, for specific date, the same date should be used for start/end date Default no specific dates In order to reset the dates to have no specific dates Date format yyyy- mm-dd (MM = month, dd = day, yyyy = year), property of the request body.
description (string) – Condition description, property of the request body.
dictionary_name (string) – Dictionary name, property of the request body.
dictionary_value (string) – Dictionary value, property of the request body.
hours_range (object) – Defines for which hours a TimeAndDate condition will be matched Time format hh:mm ( h = hour , mm = minutes ) Default All Day , property of the request body.
hours_range_exception (object) – Defines for which hours a TimeAndDate condition will be matched Time format hh:mm ( h = hour , mm = minutes ) Default All Day , property of the request body.
id (basestring) – id, property of the request body.
is_negate (boolean) – Indicates whereas this condition is in negate mode, property of the request body.
link (object) – link, property of the request body.
name (string) – Condition name, property of the request body.
operator (string) – Equality operator, property of the request body. Available values are ‘contains’, ‘endsWith’, ‘equals’, ‘greaterOrEquals’, ‘greaterThan’, ‘in’, ‘ipEquals’, ‘ipGreaterThan’, ‘ipLessThan’, ‘ipNotEquals’, ‘lessOrEquals’, ‘lessThan’, ‘matches’, ‘notContains’, ‘notEndsWith’, ‘notEquals’, ‘notIn’, ‘notStartsWith’ and ‘startsWith’.
week_days (list) – Defines for which days this condition will be matched Days format Arrays of WeekDay enums Default List of All week days, property of the request body (list of strings. Available values are ‘Friday’, ‘Monday’, ‘Saturday’, ‘Sunday’, ‘Thursday’, ‘Tuesday’ and ‘Wednesday’).
week_days_exception (list) – Defines for which days this condition will NOT be matched Days format Arrays of WeekDay enums Default Not enabled, property of the request body (list of strings. Available values are ‘Friday’, ‘Monday’, ‘Saturday’, ‘Sunday’, ‘Thursday’, ‘Tuesday’ and ‘Wednesday’).
id – id path parameter. Condition id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, attribute_name=None, attribute_value=None, children=None, condition_type=None, dates_range=None, dates_range_exception=None, description=None, dictionary_name=None, dictionary_value=None, hours_range=None, hours_range_exception=None, is_negate=None, link=None, name=None, operator=None, week_days=None, week_days_exception=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_device_admin_time_condition_by_id
-
delete_device_admin_time_condition_by_id
(id, headers=None, **query_parameters)[source]¶ Device Admin Delete Time/Date condition.
- Parameters
id (basestring) – id path parameter. Condition id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_device_admin_time_condition_by_id
-
downloadable_acl¶
-
class
DownloadableAcl
[source]¶ Identity Services Engine DownloadableACL API (version: 3.1.1).
Wraps the Identity Services Engine DownloadableACL API and exposes the API as native Python methods that return native Python objects.
Downloadable ACL API allows the client to add, delete, update, search and perform actions on downloadable ACL.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
Revision Modification
Revision Modification
Attribute
Description
0
1.0
2.3
Initial Cisco ISE Version
1
1.1
2.6
Support new attribute IP version in 2.6
daclType
Added Enum Attribute ‘daclType’
Resource Definition
Attribute
Type
Required
Description
Default Values
Example Values
name
String
Yes
Resource Name. Name may contain alphanumeric or any of the following characters [_.-]
multiline_acl
id
String
Yes
Resource UUID
c1e0e9e0-717f-11eb-9fb2-b6cb23d38630
description
String
No
Use the string n for a newline
description
dacl
String
Yes
The DACL Content. Use the string n for a newline
permit ip any any
daclType
Enum
No
Allowed values: IPV4, IPV6, IP_AGNOSTIC
IPV4
-
get_downloadable_acl_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get a downloadable ACL by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_downloadable_acl_by_id
-
update_downloadable_acl_by_id
(id, dacl=None, dacl_type=None, description=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update a downloadable ACL.
- Parameters
dacl (string) – The DACL Content. Use the string n for a newline, property of the request body.
dacl_type (string) – Allowed values: IPV4, IPV6, IP_AGNOSTIC, property of the request body.
description (string) – Use the string n for a newline, property of the request body.
id (basestring) – id, property of the request body.
name (string) – Resource Name. Name may contain alphanumeric or any of the following characters [_.-], property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, dacl=None, dacl_type=None, description=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_downloadable_acl_by_id
-
delete_downloadable_acl_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes a downloadable ACL.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_downloadable_acl_by_id
-
get_downloadable_acl
(page=None, size=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all downloadable ACLs.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_downloadable_acl
-
get_downloadable_acl_generator
(page=None, size=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all downloadable ACLs.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_downloadable_acl_generator
-
create_downloadable_acl
(dacl=None, dacl_type=None, description=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates a downloadable ACL.
- Parameters
dacl (string) – The DACL Content. Use the string n for a newline, property of the request body.
dacl_type (string) – Allowed values: IPV4, IPV6, IP_AGNOSTIC, property of the request body.
description (string) – Use the string n for a newline, property of the request body.
name (string) – Resource Name. Name may contain alphanumeric or any of the following characters [_.-], property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(dacl=None, dacl_type=None, description=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_downloadable_acl
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the downloadable ACL.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
egress_matrix_cell¶
-
class
EgressMatrixCell
[source]¶ Identity Services Engine EgressMatrixCell API (version: 3.1.1).
Wraps the Identity Services Engine EgressMatrixCell API and exposes the API as native Python methods that return native Python objects.
Egress Policy Matrix Cell API allows the client to add, update, delete and search egress matrix cells among other operations.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.0
Initial Cisco ISE Version
1
1.1
2.3
Introducing bulk operations
Resource Definition
Attribute
Type
Required
Description
Default Values
Example Values
name
String
Yes
Resource Name
ANY-ANY
id
String
No
Resource UUID, mandatory for update
f92c1a900-8c01-11e6-996c-525400b48521
description
String
No
Default egress rule
defaultRule
Enum
Yes
Allowed values: NONE, DENY_IP, PERMIT_IP
NONE
PERMIT_IP
destinationSgtId
String
Yes
92bb1950-8c01-11e6-996c-525400b48521
matrixCellStatus
Enum
Yes
Allowed values: DISABLED, ENABLED, MONITOR
DISABLED
ENABLED
sgACLs
List
Yes
[“92951ac0-8c01-11e6-996c-525400b48521”]
sourceSgtId
String
Yes
92bb1950-8c01-11e6-996c-525400b48521
-
clear_all_matrix_cells
(headers=None, **query_parameters)[source]¶ This API allows the client to clear all the egress matrix cells.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
clear
(headers=None, **query_parameters)[source]¶ Alias for clear_all_matrix_cells
-
set_all_cells_status
(status, headers=None, **query_parameters)[source]¶ his API allows the client to set status of all the egress matrix cells.
- Parameters
status (basestring) – status path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
set_status
(status, headers=None, **query_parameters)[source]¶ Alias for set_all_cells_status
-
clone_matrix_cell
(dst_sgt_id, id, src_sgt_id, headers=None, **query_parameters)[source]¶ This API allows the client to clone an egress matrix cell.
- Parameters
id (basestring) – id path parameter.
src_sgt_id (basestring) – srcSgtId path parameter.
dst_sgt_id (basestring) – dstSgtId path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
clone
(dst_sgt_id, id, src_sgt_id, headers=None, **query_parameters)[source]¶ Alias for clone_matrix_cell
-
get_egress_matrix_cell_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get an egress matrix cell by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_egress_matrix_cell_by_id
-
update_egress_matrix_cell_by_id
(id, default_rule=None, description=None, destination_sgt_id=None, matrix_cell_status=None, name=None, sgacls=None, source_sgt_id=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update an egress matrix cell.
- Parameters
default_rule (string) – Allowed values: NONE, DENY_IP, PERMIT_IP, property of the request body.
description (string) – description, property of the request body.
destination_sgt_id (string) – destinationSgtId, property of the request body.
id (basestring) – id, property of the request body.
matrix_cell_status (string) – Allowed values: DISABLED, ENABLED, MONITOR, property of the request body.
name (string) – name, property of the request body.
sgacls (list) – sgacls, property of the request body (list of strings).
source_sgt_id (string) – sourceSgtId, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, default_rule=None, description=None, destination_sgt_id=None, matrix_cell_status=None, name=None, sgacls=None, source_sgt_id=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_egress_matrix_cell_by_id
-
delete_egress_matrix_cell_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes an egress matrix cell.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_egress_matrix_cell_by_id
-
get_egress_matrix_cell
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the egress matrix cell. Filter: [sgtSrcValue, matrixStatus, description, sgtSrcName, sgtDstName, sgtDstValue] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [description, sgtSrcName, sgtDstName, sgtDstValue].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_egress_matrix_cell
-
get_egress_matrix_cell_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the egress matrix cell. Filter: [sgtSrcValue, matrixStatus, description, sgtSrcName, sgtDstName, sgtDstValue] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [description, sgtSrcName, sgtDstName, sgtDstValue].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_egress_matrix_cell_generator
-
create_egress_matrix_cell
(default_rule=None, description=None, destination_sgt_id=None, matrix_cell_status=None, name=None, sgacls=None, source_sgt_id=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates an egress matrix cell.
- Parameters
default_rule (string) – Allowed values: NONE, DENY_IP, PERMIT_IP, property of the request body.
description (string) – description, property of the request body.
destination_sgt_id (string) – destinationSgtId, property of the request body.
matrix_cell_status (string) – Allowed values: DISABLED, ENABLED, MONITOR, property of the request body.
name (string) – name, property of the request body.
sgacls (list) – sgacls, property of the request body (list of strings).
source_sgt_id (string) – sourceSgtId, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(default_rule=None, description=None, destination_sgt_id=None, matrix_cell_status=None, name=None, sgacls=None, source_sgt_id=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_egress_matrix_cell
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the egress matrix cell.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
bulk_request_for_egress_matrix_cell
(operation_type=None, resource_media_type=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to submit the bulk request.
- Parameters
operation_type (string) – operationType, property of the request body.
resource_media_type (string) – resourceMediaType, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
bulk_request
(operation_type=None, resource_media_type=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for bulk_request_for_egress_matrix_cell
-
monitor_bulk_status_egress_matrix_cell
(bulkid, headers=None, **query_parameters)[source]¶ This API allows the client to monitor the bulk request.
- Parameters
bulkid (basestring) – bulkid path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
monitor_bulk_status
(bulkid, headers=None, **query_parameters)[source]¶ Alias for monitor_bulk_status_egress_matrix_cell
-
endpoint_certificate¶
-
class
EndpointCertificate
[source]¶ Identity Services Engine EndpointCertificate API (version: 3.1.1).
Wraps the Identity Services Engine EndpointCertificate API and exposes the API as native Python methods that return native Python objects.
Endpoint Certificate API allows the client to create endpoint certificates signed by the Cisco ISE Internal CA. This API can takes in certificate request details, create a RSA key pair, create a certificate and return the resulting key pair and certificate as a ZIP file. ZIP files are returned as an octet stream.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.0
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Example Values
name
String
Yes
Resource Name
id
String
No
Resource UUID, mandatory for update
description
String
No
certTemplateName
String
Yes
Name of an Internal CA template
Certificate_Template_Name
format
Enum
Yes
Allowed values: PKCS12, PKCS12_CHAIN, PKCS8, PKCS8_CHAIN
PKCS8
password
String
Yes
Protects the private key. Must have more than 8 characters, less than 15 characters, at least one upper case letter, at least one lower case letter, at least one digit, and can only contain [A-Z][a-z][0-9]_#
Password_123
certificateRequest
Map
Yes
Key value map. Must have CN and SAN entries
CN
String
Yes
Matches the requester’s User Name, unless the Requester is an ERS Admin. ERS Admins are allowed to create requests for any CN
userName [or] machineName
SAN
String
Yes
Valid MAC Address, delimited by ‘-’
11-22-33-44-55-66
-
create_endpoint_certificate
(cert_template_name=None, certificate_request=None, format=None, password=None, dirpath=None, save_file=None, filename=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to create an endpoint certificate.
- Parameters
cert_template_name (string) – Name of an Internal CA template, property of the request body.
certificate_request (object) – Key value map. Must have CN and SAN entries, property of the request body.
format (string) – Allowed values: PKCS12, PKCS12_CHAIN, PKCS8, PKCS8_CHAIN, property of the request body.
password (string) – Protects the private key. Must have more than 8 characters, less than 15 characters, at least one upper case letter, at least one lower case letter, at least one digit, and can only contain [A-Z][a-z][0-9]_#, property of the request body.
dirpath (basestring) – Directory absolute path. Defaults to os.getcwd().
save_file (bool) – Enable or disable automatic file creation of raw response.
filename (basestring) – The filename used to save the download file.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
The DownloadResponse wrapper. Wraps the urllib3.response.HTTPResponse. For more information check the urlib3 documentation
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
DownloadFailure – If was not able to download the raw
response to a file. –
-
create
(cert_template_name=None, certificate_request=None, format=None, password=None, dirpath=None, save_file=None, filename=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_endpoint_certificate
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the endpoint certificate.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
endpoint_identity_group¶
-
class
EndpointIdentityGroup
[source]¶ Identity Services Engine EndpointIdentityGroup API (version: 3.1.1).
Wraps the Identity Services Engine EndpointIdentityGroup API and exposes the API as native Python methods that return native Python objects.
Endpoint Identity Groups API allows the client to add, delete, update, and search endpoint groups.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
1.3
Initial Cisco ISE Version
1
1.1
2.4
Added GetByName operation
Resource Definition
Attribute
Type
Required
Description
Default Values
Example Values
name
String
Yes
Resource Name
Cisco-Meraki-Devicee
id
String
No
Resource UUID, mandatory for update
1e2700a0-8c00-11e6-996c-525400b48521
description
String
No
Identity Group for Profile: Cisco-Meraki-Device
systemDefined
Boolean
Yes
false
true
-
get_endpoint_group_by_name
(name, headers=None, **query_parameters)[source]¶ This API allows the client to get an endpoint identity group by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_name
(name, headers=None, **query_parameters)[source]¶ Alias for get_endpoint_group_by_name
-
get_endpoint_group_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get an endpoint identity group by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_endpoint_group_by_id
-
update_endpoint_group_by_id
(id, description=None, name=None, system_defined=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update an endpoint identity group.
- Parameters
description (string) – description, property of the request body.
id (basestring) – id, property of the request body.
name (string) – name, property of the request body.
system_defined (boolean) – systemDefined, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, description=None, name=None, system_defined=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_endpoint_group_by_id
-
delete_endpoint_group_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes an endpoint identity group.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_endpoint_group_by_id
-
get_endpoint_groups
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the endpoint identity groups. Filter: [name] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_endpoint_groups
-
get_endpoint_groups_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the endpoint identity groups. Filter: [name] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_endpoint_groups_generator
-
create_endpoint_group
(description=None, name=None, system_defined=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates an endpoint identity group.
- Parameters
description (string) – description, property of the request body.
name (string) – name, property of the request body.
system_defined (boolean) – systemDefined, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(description=None, name=None, system_defined=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_endpoint_group
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the endpoint identity group.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
external_radius_server¶
-
class
ExternalRadiusServer
[source]¶ Identity Services Engine ExternalRADIUSServer API (version: 3.1.1).
Wraps the Identity Services Engine ExternalRADIUSServer API and exposes the API as native Python methods that return native Python objects.
External RADIUS Server API allows the client to add, delete, update, search and perform actions on external RADIUS server.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
Revision Modification
Revision Modification
Attribute
Description
0
1.0
2.3
Initial Cisco ISE Version
1
1.1
2.6
Support new attribute Proxy Dead Timeout
proxyTimeout
Added int Attribute ‘proxyTimeout’
Resource Definition
Attribute
Type
Required
Description
Default Values
Example Values
name
String
Yes
Resource Name. Allowed charactera are alphanumeric and _ (underscore).
externalRadiusServer1
id
String
No
Resource UUID, mandatory for update
da095377-dce8-486e-933a-6ea788bbf51a
description
String
No
example external radius server
hostIP
String
Yes
The IP of the host - must be a valid IPV4 address
1.1.1.1
sharedSecret
String
Yes
Shared secret maximum length is 128 characters
sharedSecret
enableKeyWrap
Boolean
Yes
KeyWrap may only be enabled if it is supported on the device. When running in FIPS mode this option should be enabled for such devices
true
encryptionKey
String
No
The encryptionKey is required only if enableKeyWrap is true, otherwise it must be ignored or empty. The maximum length is 16 ASCII characters or 32 HEXADECIMAL characters (depend on selection in field ‘keyInputFormat’)
1616161616161616
authenticatorKey
String
No
The authenticatorKey is required only if enableKeyWrap is true, otherwise it must be ignored or empty. The maximum length is 20 ASCII characters or 40 HEXADECIMAL characters (depend on selection in field ‘keyInputFormat’)
20202020202020202020
keyInputFormat
Enum
Yes
Specifies the format of the input for fields ‘encryptionKey’ and ‘authenticatorKey’. Allowed Values: ASCII, HEXADECIMAL
ASCII
authenticationPort
Integer
Yes
Valid Range 1 to 65535
1812
accountingPort
Integer
Yes
Valid Range 1 to 65535
1813
timeout
Integer
Yes
Valid Range 1 to 120
5
retries
Integer
Yes
Valid Range 1 to 9
3
proxyTimeout
Integer
No
Valid Range 1 to 600
300
-
get_external_radius_server_by_name
(name, headers=None, **query_parameters)[source]¶ This API allows the client to get an external RADIUS server by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_name
(name, headers=None, **query_parameters)[source]¶ Alias for get_external_radius_server_by_name
-
get_external_radius_server_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get an external RADIUS server by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_external_radius_server_by_id
-
update_external_radius_server_by_id
(id, accounting_port=None, authentication_port=None, authenticator_key=None, description=None, enable_key_wrap=None, encryption_key=None, host_ip=None, key_input_format=None, name=None, proxy_timeout=None, retries=None, shared_secret=None, timeout=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update an external RADIUS server.
- Parameters
accounting_port (integer) – Valid Range 1 to 65535, property of the request body.
authentication_port (integer) – Valid Range 1 to 65535, property of the request body.
authenticator_key (string) – The authenticatorKey is required only if enableKeyWrap is true, otherwise it must be ignored or empty. The maximum length is 20 ASCII characters or 40 HEXADECIMAL characters (depend on selection in field ‘keyInputFormat’), property of the request body.
description (string) – description, property of the request body.
enable_key_wrap (boolean) – KeyWrap may only be enabled if it is supported on the device. When running in FIPS mode this option should be enabled for such devices, property of the request body.
encryption_key (string) – The encryptionKey is required only if enableKeyWrap is true, otherwise it must be ignored or empty. The maximum length is 16 ASCII characters or 32 HEXADECIMAL characters (depend on selection in field ‘keyInputFormat’), property of the request body.
host_ip (string) – The IP of the host must be a valid IPV4 address, property of the request body.
id (basestring) – id, property of the request body.
key_input_format (string) – Specifies the format of the input for fields ‘encryptionKey’ and ‘authenticatorKey’. Allowed Values: ASCII HEXADECIMAL, property of the request body.
name (string) – Resource Name. Allowed charactera are alphanumeric and _ (underscore)., property of the request body.
proxy_timeout (integer) – Valid Range 1 to 600, property of the request body.
retries (integer) – Valid Range 1 to 9, property of the request body.
shared_secret (string) – Shared secret maximum length is 128 characters, property of the request body.
timeout (integer) – Valid Range 1 to 120, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, accounting_port=None, authentication_port=None, authenticator_key=None, description=None, enable_key_wrap=None, encryption_key=None, host_ip=None, key_input_format=None, name=None, proxy_timeout=None, retries=None, shared_secret=None, timeout=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_external_radius_server_by_id
-
delete_external_radius_server_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes an external RADIUS server.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_external_radius_server_by_id
-
get_external_radius_server
(page=None, size=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the external RADIUS servers.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_external_radius_server
-
get_external_radius_server_generator
(page=None, size=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the external RADIUS servers.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_external_radius_server_generator
-
create_external_radius_server
(accounting_port=None, authentication_port=None, authenticator_key=None, description=None, enable_key_wrap=None, encryption_key=None, host_ip=None, key_input_format=None, name=None, proxy_timeout=None, retries=None, shared_secret=None, timeout=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates an external RADIUS server.
- Parameters
accounting_port (integer) – Valid Range 1 to 65535, property of the request body.
authentication_port (integer) – Valid Range 1 to 65535, property of the request body.
authenticator_key (string) – The authenticatorKey is required only if enableKeyWrap is true, otherwise it must be ignored or empty. The maximum length is 20 ASCII characters or 40 HEXADECIMAL characters (depend on selection in field ‘keyInputFormat’), property of the request body.
description (string) – description, property of the request body.
enable_key_wrap (boolean) – KeyWrap may only be enabled if it is supported on the device. When running in FIPS mode this option should be enabled for such devices, property of the request body.
encryption_key (string) – The encryptionKey is required only if enableKeyWrap is true, otherwise it must be ignored or empty. The maximum length is 16 ASCII characters or 32 HEXADECIMAL characters (depend on selection in field ‘keyInputFormat’), property of the request body.
host_ip (string) – The IP of the host must be a valid IPV4 address, property of the request body.
key_input_format (string) – Specifies the format of the input for fields ‘encryptionKey’ and ‘authenticatorKey’. Allowed Values: ASCII HEXADECIMAL, property of the request body.
name (string) – Resource Name. Allowed charactera are alphanumeric and _ (underscore)., property of the request body.
proxy_timeout (integer) – Valid Range 1 to 600, property of the request body.
retries (integer) – Valid Range 1 to 9, property of the request body.
shared_secret (string) – Shared secret maximum length is 128 characters, property of the request body.
timeout (integer) – Valid Range 1 to 120, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(accounting_port=None, authentication_port=None, authenticator_key=None, description=None, enable_key_wrap=None, encryption_key=None, host_ip=None, key_input_format=None, name=None, proxy_timeout=None, retries=None, shared_secret=None, timeout=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_external_radius_server
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the external RADIUS server.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
filter_policy¶
-
class
FilterPolicy
[source]¶ Identity Services Engine FilterPolicy API (version: 3.1.1).
Wraps the Identity Services Engine FilterPolicy API and exposes the API as native Python methods that return native Python objects.
Filter Policy API allows clients to add, get, update and delete SXP domain filter policies.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
3.0
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Example Values
name
String
Yes
Resource Name
id
String
No
Resource UUID, mandatory for update
description
String
No
subnet
String
No
Subnet for filter policy (hostname is not supported). At least one of subnet or sgt or vn should be defined
subnetAddress
sgt
String
No
SGT name or ID. At least one of subnet or sgt or vn should be defined
sgt
vn
String
No
Virtual Network. At least one of subnet or sgt or vn should be defined
virtualNetwork
domains
String
Yes
List of SXP Domains, separated with comma
Sxp Vpn Name
-
get_filter_policy_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get a filter policy by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_filter_policy_by_id
-
update_filter_policy_by_id
(id, domains=None, sgt=None, subnet=None, vn=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update a filter policy.
- Parameters
domains (string) – List of SXP Domains, separated with comma, property of the request body.
sgt (string) – SGT name or ID. At least one of subnet or sgt or vn should be defined, property of the request body.
subnet (string) – Subnet for filter policy (hostname is not supported). At least one of subnet or sgt or vn should be defined, property of the request body.
vn (string) – Virtual Network. At least one of subnet or sgt or vn should be defined, property of the request body.
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, domains=None, sgt=None, subnet=None, vn=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_filter_policy_by_id
-
delete_filter_policy_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes a filter policy.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_filter_policy_by_id
-
get_filter_policy
(page=None, size=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the filter policies.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_filter_policy
-
get_filter_policy_generator
(page=None, size=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the filter policies.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_filter_policy_generator
-
create_filter_policy
(domains=None, sgt=None, subnet=None, vn=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates a filter policy.
- Parameters
domains (string) – List of SXP Domains, separated with comma, property of the request body.
sgt (string) – SGT name or ID. At least one of subnet or sgt or vn should be defined, property of the request body.
subnet (string) – Subnet for filter policy (hostname is not supported). At least one of subnet or sgt or vn should be defined, property of the request body.
vn (string) – Virtual Network. At least one of subnet or sgt or vn should be defined, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(domains=None, sgt=None, subnet=None, vn=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_filter_policy
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the filter policy.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
guest_location¶
-
class
GuestLocation
[source]¶ Identity Services Engine GuestLocation API (version: 3.1.1).
Wraps the Identity Services Engine GuestLocation API and exposes the API as native Python methods that return native Python objects.
Guest Location API allows the client to search the locations configured from Cisco ISE GUI.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.2
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Example Values
name
String
Yes
Resource Name
name
id
String
No
Resource UUID, mandatory for update
9f083530-8c01-11e6-996c-525400b48521
description
String
No
-
get_guest_location_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get a guest location by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_guest_location_by_id
-
get_guest_location
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the guest locations. Filter: [name] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_guest_location
-
get_guest_location_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the guest locations. Filter: [name] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_guest_location_generator
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the guest location.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
guest_smtp_notification_configuration¶
-
class
GuestSmtpNotificationConfiguration
[source]¶ Identity Services Engine GuestSMTPNotificationConfiguration API (version: 3.1.1).
Wraps the Identity Services Engine GuestSMTPNotificationConfiguration API and exposes the API as native Python methods that return native Python objects.
Guest SMTP notification configuration API is a global setting for enabling email notifications within guest application. These APIs allow to create, update and retrieve the notification settings. The create API may not be required to be used as of Cisco ISE Release 2.2 because the single SMTP notification configuration is the only one used and it always gets created during the Cisco ISE application initialization period.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.2
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Default Values
Example Values
name
String
Yes
Resource Name
id
String
No
Resource UUID, mandatory for update
9ecb5340-8c01-11e6-996c-525400b48521
description
String
No
defaultFromAddress
String
No
The default from email address to be used to send emails from
notificationEnabled
Boolean
No
Indicates if the email notification service is to be enabled
true
smtpServer
String
No
The SMTP server ip address or fqdn such as outbound.mycompany.com
useDefaultFromAddress
Boolean
No
If the default from address should be used rather than using a sponsor user email address
false
smtpPort
String
No
Port at which SMTP Secure Server is listening
25
connectionTimeout
String
No
Interval in seconds for all the SMTP client connections
60
useTLSorSSLEncryption
Boolean
No
If configured to true, SMTP server authentication will happen using TLS/SSL
false
usePasswordAuthentication
Boolean
No
If configured to true, SMTP server authentication will happen using username/password
false
userName
String
No
Username of Secure SMTP server
password
String
No
Password of Secure SMTP server
-
get_guest_smtp_notification_settings_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get a guest SMTP notification configuration by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_guest_smtp_notification_settings_by_id
(id, connection_timeout=None, default_from_address=None, notification_enabled=None, password=None, smtp_port=None, smtp_server=None, use_default_from_address=None, use_password_authentication=None, use_tlsor_ssl_encryption=None, user_name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update a SMTP configuration setting.
- Parameters
connection_timeout (string) – Interval in seconds for all the SMTP client connections, property of the request body.
default_from_address (string) – The default from email address to be used to send emails from, property of the request body.
id (basestring) – id, property of the request body.
notification_enabled (boolean) – Indicates if the email notification service is to be enabled, property of the request body.
password (string) – Password of Secure SMTP server, property of the request body.
smtp_port (string) – Port at which SMTP Secure Server is listening, property of the request body.
smtp_server (string) – The SMTP server ip address or fqdn such as outbound.mycompany.com, property of the request body.
use_default_from_address (boolean) – If the default from address should be used rather than using a sponsor user email address, property of the request body.
use_password_authentication (boolean) – If configured to true, SMTP server authentication will happen using username/password, property of the request body.
use_tlsor_ssl_encryption (boolean) – If configured to true, SMTP server authentication will happen using TLS/SSL, property of the request body.
user_name (string) – Username of Secure SMTP server, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, connection_timeout=None, default_from_address=None, notification_enabled=None, password=None, smtp_port=None, smtp_server=None, use_default_from_address=None, use_password_authentication=None, use_tlsor_ssl_encryption=None, user_name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
-
get_guest_smtp_notification_settings
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the guest SMTP notification configurations. Filter: [name] To search guest users by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_guest_smtp_notification_settings
-
get_guest_smtp_notification_settings_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the guest SMTP notification configurations. Filter: [name] To search guest users by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶
-
create_guest_smtp_notification_settings
(connection_timeout=None, default_from_address=None, notification_enabled=None, password=None, smtp_port=None, smtp_server=None, use_default_from_address=None, use_password_authentication=None, use_tlsor_ssl_encryption=None, user_name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates a guest SMTP notification configuration.
- Parameters
connection_timeout (string) – Interval in seconds for all the SMTP client connections, property of the request body.
default_from_address (string) – The default from email address to be used to send emails from, property of the request body.
notification_enabled (boolean) – Indicates if the email notification service is to be enabled, property of the request body.
password (string) – Password of Secure SMTP server, property of the request body.
smtp_port (string) – Port at which SMTP Secure Server is listening, property of the request body.
smtp_server (string) – The SMTP server ip address or fqdn such as outbound.mycompany.com, property of the request body.
use_default_from_address (boolean) – If the default from address should be used rather than using a sponsor user email address, property of the request body.
use_password_authentication (boolean) – If configured to true, SMTP server authentication will happen using username/password, property of the request body.
use_tlsor_ssl_encryption (boolean) – If configured to true, SMTP server authentication will happen using TLS/SSL, property of the request body.
user_name (string) – Username of Secure SMTP server, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(connection_timeout=None, default_from_address=None, notification_enabled=None, password=None, smtp_port=None, smtp_server=None, use_default_from_address=None, use_password_authentication=None, use_tlsor_ssl_encryption=None, user_name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_guest_smtp_notification_settings
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the guest smtp notification configuration.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
guest_ssid¶
-
class
GuestSsid
[source]¶ Identity Services Engine GuestSSID API (version: 3.1.1).
Wraps the Identity Services Engine GuestSSID API and exposes the API as native Python methods that return native Python objects.
Guest SSIDs are global objects that are referenced by Cisco ISE sponsor portals. Guest SSID API allows the client to add, delete, update and search guest SSID among other operations which are available from all the portals.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.2
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Example Values
name
String
Yes
Resource Name. Name may contain alphanumeric or any of the following characters [_.-]
ssid_value
id
String
No
Resource UUID, mandatory for update
9132eedc-7910-4ffe-805e-3d3a366f7fb7
description
String
No
-
get_guest_ssid_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get a guest SSID by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_guest_ssid_by_id
-
update_guest_ssid_by_id
(id, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update a guest SSID by ID.
- Parameters
id (basestring) – id, property of the request body.
name (string) – Resource Name. Name may contain alphanumeric or any of the following characters [_.-], property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_guest_ssid_by_id
-
delete_guest_ssid_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes a guest SSID by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_guest_ssid_by_id
-
get_guest_ssid
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the guest SSIDs. Filter: [name] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_guest_ssid
-
get_guest_ssid_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the guest SSIDs. Filter: [name] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_guest_ssid_generator
-
create_guest_ssid
(name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates a guest SSID.
- Parameters
name (string) – Resource Name. Name may contain alphanumeric or any of the following characters [_.-], property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_guest_ssid
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the guest SSID.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
guest_type¶
-
class
GuestType
[source]¶ Identity Services Engine GuestType API (version: 3.1.1).
Wraps the Identity Services Engine GuestType API and exposes the API as native Python methods that return native Python objects.
Guest Type API allows the client to add, delete, update and search guest types.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.2
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Default Values
Example Values
name
String
Yes
Resource Name
Contractor (default)
id
String
No
Resource UUID, mandatory for update
9f03a151-8c01-11e6-996c-525400b48521
description
String
No
Default settings allow network access for up to a year.
accessTime
List
No
allowAccessOnSpecificDaysTimes
Boolean
No
Enable Specific Day Time Limits
false
defaultDuration
Integer
No
90
durationTimeUnit
Enum
No
Allowed values are: - DAYS, - HOURS, - MINUTES
DAYS
fromFirstLogin
Boolean
No
When Account Duration starts from first login or specified date
false
maxAccountDuration
Integer
No
Maximum value of Account Duration
365
dayTimeLimits
List
No
List of Time Ranges for account access
dayTimeLimit
List
No
Time Ranges for account access
startTime
String
No
Start time in HH:mm format
09:00
endTime
String
No
End time in HH:mm format
17:00
days
List
No
List of Days
day
Enum
No
Value should be one of Week day. Allowed values are: - Sunday, - Monday, - Tuesday, - Wednesday, - Thursday, - Friday, - Saturday
loginOptions
List
No
Login options
allowGuestPortalBypass
Boolean
No
false
failureAction
Enum
No
When Guest Exceeds limit this action will be invoked, Allowed values are: - Disconnect_Oldest_Connection, - Disconnect_Newest_Connection
Disconnect_Oldest_Connection
identityGroupId
String
Yes
ID of Guest Identity Group
aa178bd0-8bff-11e6-996c-525400b48521
limitSimultaneousLogins
Boolean
No
Enable Simultaneous Logins
true
maxRegisteredDevices
Integer
No
Maximum devices guests can register
5
maxSimultaneousLogins
Integer
No
Number of Simultaneous Logins
3
expirationNotification
List
No
Expiration Notification Settings
advanceNotificationDuration
Integer
No
Send Account Expiration Notification Duration before ( Days, Hours, Minutes )
3
advanceNotificationUnits
Enum
No
Allowed values are: - DAYS, - HOURS, - MINUTES
DAYS
enableNotification
Boolean
No
Enable Notification settings
false
sendEmailNotification
Boolean
No
Enable Email Notification
false
sendSmsNotification
Integer
No
Maximum devices guests can register
5
sponsorGroups
List
Yes
List of Sponsor Groups
[“GROUP_ACCOUNTS (default)”, “ALL_ACCOUNTS (default)”, “OWN_ACCOUNTS (default)”]
-
update_guest_type_email
(id, additional_data=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update a guest type email by ID.
- Parameters
additional_data (list) – additionalData, property of the request body (list of objects).
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_email
(id, additional_data=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_guest_type_email
-
update_guest_type_sms
(id, additional_data=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update a guest type sms by ID.
- Parameters
additional_data (list) – additionalData, property of the request body (list of objects).
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_sms
(id, additional_data=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_guest_type_sms
-
get_guest_type_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get a guest type by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_guest_type_by_id
-
update_guest_type_by_id
(id, access_time=None, description=None, expiration_notification=None, is_default_type=None, login_options=None, name=None, sponsor_groups=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update a guest type.
- Parameters
access_time (object) – accessTime, property of the request body.
description (string) – description, property of the request body.
expiration_notification (object) – Expiration Notification Settings, property of the request body.
id (basestring) – id, property of the request body.
is_default_type (boolean) – isDefaultType, property of the request body.
login_options (object) – loginOptions, property of the request body.
name (string) – name, property of the request body.
sponsor_groups (list) – sponsorGroups, property of the request body (list of strings).
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, access_time=None, description=None, expiration_notification=None, is_default_type=None, login_options=None, name=None, sponsor_groups=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_guest_type_by_id
-
delete_guest_type_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes a guest type.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_guest_type_by_id
-
get_guest_type
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the guest types. Filter: [name] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_guest_type
-
get_guest_type_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the guest types. Filter: [name] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_guest_type_generator
-
create_guest_type
(access_time=None, description=None, expiration_notification=None, is_default_type=None, login_options=None, name=None, sponsor_groups=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates a guest type.
- Parameters
access_time (object) – accessTime, property of the request body.
description (string) – description, property of the request body.
expiration_notification (object) – Expiration Notification Settings, property of the request body.
is_default_type (boolean) – isDefaultType, property of the request body.
login_options (object) – loginOptions, property of the request body.
name (string) – name, property of the request body.
sponsor_groups (list) – sponsorGroups, property of the request body (list of strings).
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(access_time=None, description=None, expiration_notification=None, is_default_type=None, login_options=None, name=None, sponsor_groups=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_guest_type
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the guest type.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
guest_user¶
-
class
GuestUser
[source]¶ Identity Services Engine GuestUser API (version: 3.1.1).
Wraps the Identity Services Engine GuestUser API and exposes the API as native Python methods that return native Python objects.
Guest User API allows the client to add, delete, update and search guest users among other operations which are available from the sponsor portal. Please note that each API description shows whether the API is supported in bulk operation. The bulk section is showing only ‘create’ bulk operation. However, all other operation which are bulk supported can be used in the same way.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
1.2
Initial Cisco ISE Version
1
2.0
1.3
Introducing new schema - not supporting 1.0 anymore
Resource Definition
Attribute
Type
Required
Description
Default Values
Example Values
name
String
Yes
Resource Name
guestUser
id
String
No
Resource UUID, mandatory for update
ab6deded-fcc2-47ff-8577-0014737c8fcf
description
String
No
ERS Example user
customFields
Map
No
Key value map
“some key” : “some value”
guestType
String
No
Contractor
status
String
No
reasonForVisit
String
No
personBeingVisited
String
No
sponsorUserName
String
No
Mr Spons
sponsorUserId
String
No
statusReason
String
No
portalId
String
No
23423432523
guestAccessInfo
List
No
validDays
Integer
Yes
Number of days guest user is valid. To validate validDays property, Cisco ISE considers only date (not time) between fromDate and toDate properites
90
fromDate
String
No
07/29/2014 14:44
toDate
String
No
10/29/2014 17:30
location
String
No
San Jose
ssid
String
No
groupTag
String
No
GuestInfo
List
Yes
emailAddress
String
No
enabled
Boolean
Yes
This field is only for Get operation not applicable for Create, Update operations
false
password
String
Yes
asdlkj324ew
phoneNumber
String
No
Phone number should be E.164 format
+13211239034
smsServiceProvider
String
No
Global Default
userName
String
No
If account needs be created with mobile number, please provide mobile number here
DS3ewdsa34wWE
firstName
String
No
lastName
String
No
company
String
No
creationTime
String
No
notificationLanguage
String
No
-
approve_guest_user_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to approve a guest user by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
approve_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for approve_guest_user_by_id
-
change_sponsor_password
(portal_id, additional_data=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to change the sponsor password.
- Parameters
additional_data (list) – additionalData, property of the request body (list of objects).
portal_id (basestring) – portalId path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
suspend_guest_user_by_name
(name, headers=None, **query_parameters)[source]¶ This API allows the client to suspend a guest user by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
suspend_by_name
(name, headers=None, **query_parameters)[source]¶ Alias for suspend_guest_user_by_name
-
reinstate_guest_user_by_name
(name, headers=None, **query_parameters)[source]¶ This API allows the client to reinstate a guest user by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
reinstate_by_name
(name, headers=None, **query_parameters)[source]¶ Alias for reinstate_guest_user_by_name
-
get_guest_user_by_name
(name, headers=None, **query_parameters)[source]¶ This API allows the client to get a guest user by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_name
(name, headers=None, **query_parameters)[source]¶ Alias for get_guest_user_by_name
-
update_guest_user_by_name
(name, custom_fields=None, description=None, guest_access_info=None, guest_info=None, guest_type=None, id=None, portal_id=None, reason_for_visit=None, sponsor_user_id=None, sponsor_user_name=None, status=None, status_reason=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update a guest user by name.
- Parameters
custom_fields (object) – Key value map, property of the request body.
description (string) – description, property of the request body.
guest_access_info (object) – guestAccessInfo, property of the request body.
guest_info (object) – guestInfo, property of the request body.
guest_type (string) – guestType, property of the request body.
id (string) – id, property of the request body.
name (basestring) – name, property of the request body.
portal_id (string) – portalId, property of the request body.
reason_for_visit (string) – reasonForVisit, property of the request body.
sponsor_user_id (string) – sponsorUserId, property of the request body.
sponsor_user_name (string) – sponsorUserName, property of the request body.
status (string) – status, property of the request body.
status_reason (string) – statusReason, property of the request body.
name – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_name
(name, custom_fields=None, description=None, guest_access_info=None, guest_info=None, guest_type=None, id=None, portal_id=None, reason_for_visit=None, sponsor_user_id=None, sponsor_user_name=None, status=None, status_reason=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_guest_user_by_name
-
delete_guest_user_by_name
(name, headers=None, **query_parameters)[source]¶ This API deletes a guest user.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_name
(name, headers=None, **query_parameters)[source]¶ Alias for delete_guest_user_by_name
-
reset_guest_user_password_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to reset the guest user password.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
reset_password_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for reset_guest_user_password_by_id
-
reinstate_guest_user_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to reinstate a guest user by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
reinstate_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for reinstate_guest_user_by_id
-
update_guest_user_email
(id, portal_id, additional_data=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update a guest user email by ID.
- Parameters
additional_data (list) – additionalData, property of the request body (list of objects).
id (basestring) – id path parameter.
portal_id (basestring) – portalId path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_email
(id, portal_id, additional_data=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_guest_user_email
-
update_guest_user_sms
(id, portal_id, headers=None, **query_parameters)[source]¶ This API allows the client to update a guest user sms by ID.
- Parameters
id (basestring) – id path parameter.
portal_id (basestring) – portalId path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_sms
(id, portal_id, headers=None, **query_parameters)[source]¶ Alias for update_guest_user_sms
-
deny_guest_user_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to deny a guest user by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
deny_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for deny_guest_user_by_id
-
get_guest_user_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get a guest user by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_guest_user_by_id
-
update_guest_user_by_id
(id, custom_fields=None, description=None, guest_access_info=None, guest_info=None, guest_type=None, name=None, portal_id=None, reason_for_visit=None, sponsor_user_id=None, sponsor_user_name=None, status=None, status_reason=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update a guest user by ID.
- Parameters
custom_fields (object) – Key value map, property of the request body.
description (string) – description, property of the request body.
guest_access_info (object) – guestAccessInfo, property of the request body.
guest_info (object) – guestInfo, property of the request body.
guest_type (string) – guestType, property of the request body.
id (basestring) – id, property of the request body.
name (string) – name, property of the request body.
portal_id (string) – portalId, property of the request body.
reason_for_visit (string) – reasonForVisit, property of the request body.
sponsor_user_id (string) – sponsorUserId, property of the request body.
sponsor_user_name (string) – sponsorUserName, property of the request body.
status (string) – status, property of the request body.
status_reason (string) – statusReason, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, custom_fields=None, description=None, guest_access_info=None, guest_info=None, guest_type=None, name=None, portal_id=None, reason_for_visit=None, sponsor_user_id=None, sponsor_user_name=None, status=None, status_reason=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_guest_user_by_id
-
delete_guest_user_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes a guest user by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_guest_user_by_id
-
get_guest_users
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the guest users. Filter: [lastName, sponsor, creationTime, personBeingVisited, toDate, userName, firstName, emailAddress, phoneNumber, groupTag, name, company, guestType, status] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [firstName, lastName, emailAddress, name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_guest_users
-
get_guest_users_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the guest users. Filter: [lastName, sponsor, creationTime, personBeingVisited, toDate, userName, firstName, emailAddress, phoneNumber, groupTag, name, company, guestType, status] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [firstName, lastName, emailAddress, name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_guest_users_generator
-
create_guest_user
(custom_fields=None, description=None, guest_access_info=None, guest_info=None, guest_type=None, name=None, portal_id=None, reason_for_visit=None, sponsor_user_id=None, sponsor_user_name=None, status=None, status_reason=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates a guest user.
- Parameters
custom_fields (object) – Key value map, property of the request body.
description (string) – description, property of the request body.
guest_access_info (object) – guestAccessInfo, property of the request body.
guest_info (object) – guestInfo, property of the request body.
guest_type (string) – guestType, property of the request body.
name (string) – name, property of the request body.
portal_id (string) – portalId, property of the request body.
reason_for_visit (string) – reasonForVisit, property of the request body.
sponsor_user_id (string) – sponsorUserId, property of the request body.
sponsor_user_name (string) – sponsorUserName, property of the request body.
status (string) – status, property of the request body.
status_reason (string) – statusReason, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(custom_fields=None, description=None, guest_access_info=None, guest_info=None, guest_type=None, name=None, portal_id=None, reason_for_visit=None, sponsor_user_id=None, sponsor_user_name=None, status=None, status_reason=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_guest_user
-
suspend_guest_user_by_id
(id, additional_data=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to suspend a guest user by ID.
- Parameters
additional_data (list) – additionalData, property of the request body (list of objects).
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
suspend_by_id
(id, additional_data=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for suspend_guest_user_by_id
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the guest user.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
bulk_request_for_guest_user
(operation_type=None, resource_media_type=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to submit the bulk request.
- Parameters
operation_type (string) – operationType, property of the request body.
resource_media_type (string) – resourceMediaType, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
bulk_request
(operation_type=None, resource_media_type=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for bulk_request_for_guest_user
-
monitor_bulk_status_guest_user
(bulkid, headers=None, **query_parameters)[source]¶ This API allows the client to monitor the bulk request.
- Parameters
bulkid (basestring) – bulkid path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
monitor_bulk_status
(bulkid, headers=None, **query_parameters)[source]¶ Alias for monitor_bulk_status_guest_user
hotspot_portal¶
-
class
HotspotPortal
[source]¶ Identity Services Engine HotspotPortal API (version: 3.1.1).
Wraps the Identity Services Engine HotspotPortal API and exposes the API as native Python methods that return native Python objects.
Hotspot Guest Portal API provides the ability to create, read, update, delete and search hotspot guest portals.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.2
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Default Values
Example Values
name
String
Yes
Resource Name
Hotspot Guest Portal (default)
id
String
No
Resource UUID, mandatory for update
b132a9ef-1491-4e01-9ad4-b48a9c72e1c7
description
String
No
Guests do not require username and password credentials to access the network, but you can optionally require an access code
portalTestUrl
String
No
URL to bring up a test page for this portal
https://{ise-ip}:8443/portal/PortalSetup.action?portal=b132a9ef-1491-4e01-9ad4-b48a9c72e1c7
portalType
Enum
Yes
Allowed values: BYOD, HOTSPOTGUEST, MYDEVICE, SELFREGGUEST, SPONSOR, SPONSOREDGUEST
HOTSPOTGUEST
settings
List
No
Defines all of the settings groups available for a BYOD
portalSettings
List
No
The port, interface, certificate, and other basic settings of a portal
httpsPort
Integer
Yes
The port number that the allowed interfaces will listen on. Range from 8000 to 8999
8443
allowedInterfaces
Enum
Yes
Interfaces that the portal will be reachable on. Allowed values: eth0, eth1, eth2, eth3, eth4, eth5, bond0, bond1, bond2
[ “eth0”, “bond0” ]
certificateGroupTag
String
Yes
Logical name of the x.509 server certificate that will be used for the portal
Default Portal Certificate Group
endpointIdentityGroup
String
Yes
Unique Id of the endpoint identity group where user’s devices will be added. Used only in Hotspot Portal
aa178bd0-8bff-11e6-996c-525400b48521
displayLang
Enum
No
Allowed values: USEBROWSERLOCALE, ALWAYSUSE
USEBROWSERLOCALE
fallbackLanguage
String
No
Used when displayLang = USEBROWSERLOCALE
English
alwaysUsedLanguage
String
No
Used when displayLang = ALWAYSUSE
English
coaType
Enum
No
Allowed Values: COAREAUTHENTICATE, COATERMINATE
COAREAUTHENTICATE
aupSettings
List
No
Configuration of the Acceptable Use Policy (AUP) for a portal
requireAccessCode
Boolean
No
Require the portal user to enter an access code. Only used in Hotspot portal
false
accessCode
String
No
Access code that must be entered by the portal user (only valid if requireAccessCode = true)
includeAup
Boolean
No
Require the portal user to read and accept an AUP
true
requireScrolling
Boolean
No
Require the portal user to scroll to the end of the AUP. Only valid if requireAupAcceptance = true
false
authSuccessSettings
List
No
successRedirect
Enum
No
After an Authentication Success where should device be redirected. Allowed values: AUTHSUCCESSPAGE, ORIGINATINGURL, URL
AUTHSUCCESSPAGE
redirectUrl
String
No
Target URL for redirection, used when successRedirect = URL
www.cisco.com
postLoginBannerSettings
List
No
includePostAccessBanner
Boolean
No
Include a Post-Login Banner page
false
supportInfoSettings
List
No
Portal Support Information Settings
includeSupportInfoPage
Boolean
No
false
includeMacAddr
Boolean
No
false
includeIpAddress
Boolean
No
false
includeBrowserUserAgent
Boolean
No
false
includePolicyServer
Boolean
No
false
includeFailureCode
Boolean
No
false
emptyFieldDisplay
Enum
No
Specifies how empty fields are handled on the Support Information Page. Allowed values: HIDE, DISPLAYWITHNOVALUE, DISPLAYWITHDEFAULTVALUE
HIDE
defaultEmptyFieldValue
String
No
The default value displayed for an empty field Only valid when emptyFieldDisplay = DISPLAYWITHDEFAULTVALUE
customizations
List
No
Defines all of the Portal Customizations available
portalTheme
List
No
Defines the configuration for portal theme
id
String
No
The unique internal identifier of the portal theme
9eb421c0-8c01-11e6-996c-525400b48521
name
String
Yes
The system- or user-assigned name of the portal theme
Default Blue theme
themeData
String
No
A CSS file, represented as a Base64-encoded byte array
Base 64 encoded string of Theme CSS file
portalTweakSettings
List
No
The Tweak Settings are a customization of the Portal Theme that has been selected for the portal. When the Portal Theme selection is changed, the Tweak Settings are overwritten to match the values in the theme. The Tweak Settings can subsequently be changed by the user
bannerColor
String
No
Hex value of color
#0000FF
bannerTextColor
String
No
Banner Text color code from GUI
pageBackgroundColor
String
No
Color code from GUI
pageLabelAndTextColor
String
No
Label and Text color from GUI
language
List
No
This property is supported only for Read operation and it allows to show the customizations in English. Other languages are not supported
viewLanguage
String
No
English
globalCustomizations
List
No
Represent the portal Global customizations
bannerTitle
String
No
BYOD Portal
contactText
String
No
Contact Support
footerElement
String
No
Footer Element
mobileLogoImage
Image
No
data
String
No
Represented as base 64 encoded string of the image byte array
base 64 encoded value of image
desktopLogoImage
Image
No
data
String
No
Represented as base 64 encoded string of the image byte array
base 64 encoded value of image
bannerImage
Image
No
data
String
No
Represented as base 64 encoded string of the image byte array
base 64 encoded value of image
backgroundImage
Image
No
data
String
No
Represented as base 64 encoded string of the image byte array
base 64 encoded value of image
pageCustomizations
List
No
Represent the entire page customization as a giant dictionary
data
List
No
The Dictionary will be exposed here as key value pair
key
String
Yes
ui_contact_ip_address_label
value
String
Yes
SVAgYWRkcmVzczo=
-
get_hotspot_portal_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get a hotspot portal by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_hotspot_portal_by_id
-
update_hotspot_portal_by_id
(id, customizations=None, description=None, name=None, portal_test_url=None, portal_type=None, settings=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update a hotspot portal by ID.
- Parameters
customizations (object) – Defines all of the Portal Customizations available, property of the request body.
description (string) – description, property of the request body.
id (basestring) – id, property of the request body.
name (string) – name, property of the request body.
portal_test_url (string) – URL to bring up a test page for this portal, property of the request body.
portal_type (string) – Allowed values: BYOD, HOTSPOTGUEST, MYDEVICE, SELFREGGUEST, SPONSOR, SPONSOREDGUEST, property of the request body.
settings (object) – Defines all of the settings groups available for a BYOD, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, customizations=None, description=None, name=None, portal_test_url=None, portal_type=None, settings=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_hotspot_portal_by_id
-
delete_hotspot_portal_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes a hotspot portal by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_hotspot_portal_by_id
-
get_hotspot_portal
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the hotspot portals. Filter: [name] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_hotspot_portal
-
get_hotspot_portal_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the hotspot portals. Filter: [name] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_hotspot_portal_generator
-
create_hotspot_portal
(customizations=None, description=None, name=None, portal_test_url=None, portal_type=None, settings=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates a hotspot portal.
- Parameters
customizations (object) – Defines all of the Portal Customizations available, property of the request body.
description (string) – description, property of the request body.
name (string) – name, property of the request body.
portal_test_url (string) – URL to bring up a test page for this portal, property of the request body.
portal_type (string) – Allowed values: BYOD, HOTSPOTGUEST, MYDEVICE, SELFREGGUEST, SPONSOR, SPONSOREDGUEST, property of the request body.
settings (object) – Defines all of the settings groups available for a BYOD, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(customizations=None, description=None, name=None, portal_test_url=None, portal_type=None, settings=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_hotspot_portal
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the hotspot portal.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
ip_to_sgt_mapping¶
-
class
IpToSgtMapping
[source]¶ Identity Services Engine IPToSGTMapping API (version: 3.1.1).
Wraps the Identity Services Engine IPToSGTMapping API and exposes the API as native Python methods that return native Python objects.
IP To SGT Mapping API allows the client to add, delete, update, search and deploy IP to SGT mapping.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.0
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Example Values
name
String
Yes
Resource Name
server1.cisco.com
id
String
No
Resource UUID, mandatory for update
description
String
No
deployTo
String
Mandatory unless mappingGroup is set or unless deployType=ALL
network_device_id
deployType
Enum
Yes
Allowed values: ALL, ND, NDG
ND
hostName
String
Mandatory if hostIp is empty
server1.cisco.com
sgt
String
Mandatory unless mappingGroup is set
sgt_id
hostIp
String
Mandatory if hostName is empty – valid IPL
mappingGroup
String
Mandatory unless sgt and deployTo and deployType are set
-
deploy_ip_to_sgt_mapping_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to deploy an IP to SGT mapping by ID. Only one Deploy process can run at any given time.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
deploy_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for deploy_ip_to_sgt_mapping_by_id
-
deploy_all_ip_to_sgt_mapping
(headers=None, **query_parameters)[source]¶ This API allows the client to deploy all the IP to SGT mappings. Only one Deploy process can run at any given time.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
deploy_all
(headers=None, **query_parameters)[source]¶ Alias for deploy_all_ip_to_sgt_mapping
-
get_deploy_status_ip_to_sgt_mapping
(headers=None, **query_parameters)[source]¶ This API allows the client to get the IP to SGT mapping deployment status. Deploy Status will show last Deploy command output. The information will be saved until the next Deploy command.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_deploy_status
(headers=None, **query_parameters)[source]¶ Alias for get_deploy_status_ip_to_sgt_mapping
-
get_ip_to_sgt_mapping_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get an IP to SGT mapping by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_ip_to_sgt_mapping_by_id
-
update_ip_to_sgt_mapping_by_id
(id, deploy_to=None, deploy_type=None, host_ip=None, host_name=None, mapping_group=None, name=None, sgt=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update an IP to SGT mapping by ID.
- Parameters
deploy_to (string) – Mandatory unless mappingGroup is set or unless deployType=ALL, property of the request body.
deploy_type (string) – Allowed values: ALL, ND, NDG, property of the request body.
host_ip (string) – Mandatory if hostName is empty -valid IP, property of the request body.
host_name (string) – Mandatory if hostIp is empty, property of the request body.
id (basestring) – id, property of the request body.
mapping_group (string) – Mapping Group Id. Mandatory unless sgt and deployTo and deployType are set, property of the request body.
name (string) – name, property of the request body.
sgt (string) – Mandatory unless mappingGroup is set, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, deploy_to=None, deploy_type=None, host_ip=None, host_name=None, mapping_group=None, name=None, sgt=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_ip_to_sgt_mapping_by_id
-
delete_ip_to_sgt_mapping_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes an IP to SGT mapping.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_ip_to_sgt_mapping_by_id
-
get_ip_to_sgt_mapping
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the IP to SGT mappings. Filter: [hostName, groupName, ip, sgtName] To search guest users by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [hostName, groupName, ip, sgtName].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_ip_to_sgt_mapping
-
get_ip_to_sgt_mapping_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the IP to SGT mappings. Filter: [hostName, groupName, ip, sgtName] To search guest users by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [hostName, groupName, ip, sgtName].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_ip_to_sgt_mapping_generator
-
create_ip_to_sgt_mapping
(deploy_to=None, deploy_type=None, host_ip=None, host_name=None, mapping_group=None, name=None, sgt=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates an IP to SGT mapping.
- Parameters
deploy_to (string) – Mandatory unless mappingGroup is set or unless deployType=ALL, property of the request body.
deploy_type (string) – Allowed values: ALL, ND, NDG, property of the request body.
host_ip (string) – Mandatory if hostName is empty -valid IP, property of the request body.
host_name (string) – Mandatory if hostIp is empty, property of the request body.
mapping_group (string) – Mapping Group Id. Mandatory unless sgt and deployTo and deployType are set, property of the request body.
name (string) – name, property of the request body.
sgt (string) – Mandatory unless mappingGroup is set, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(deploy_to=None, deploy_type=None, host_ip=None, host_name=None, mapping_group=None, name=None, sgt=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_ip_to_sgt_mapping
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to IP to SGT mapping.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
bulk_request_for_ip_to_sgt_mapping
(operation_type=None, resource_media_type=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to submit the bulk request.
- Parameters
operation_type (string) – operationType, property of the request body.
resource_media_type (string) – resourceMediaType, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
bulk_request
(operation_type=None, resource_media_type=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for bulk_request_for_ip_to_sgt_mapping
-
monitor_bulk_status_ip_to_sgt_mapping
(bulkid, headers=None, **query_parameters)[source]¶ This API allows the client to monitor the bulk request.
- Parameters
bulkid (basestring) – bulkid path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
monitor_bulk_status
(bulkid, headers=None, **query_parameters)[source]¶ Alias for monitor_bulk_status_ip_to_sgt_mapping
-
ip_to_sgt_mapping_group¶
-
class
IpToSgtMappingGroup
[source]¶ Identity Services Engine IPToSGTMappingGroup API (version: 3.1.1).
Wraps the Identity Services Engine IPToSGTMappingGroup API and exposes the API as native Python methods that return native Python objects.
IP To SGT Mapping Group API allows the client to add, delete, update, search and deploy IP to SGT mapping groups.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.0
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Default Values
Example Values
name
String
Yes
Resource Name
groupA
id
String
No
Resource UUID, mandatory for update
description
String
No
deployTo
String
Mandatory unless mappingGroup is set or unless deployType=ALL
network_device_id
deployType
Enum
Yes
Allowed values: ALL, ND, NDG
ALL
sgt
String
Mandatory unless mappingGroup is set
sgt_id
-
deploy_ip_to_sgt_mapping_group_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to deploy an IP to SGT mapping group by ID. Only one Deploy process can run at any given time.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
deploy_all_ip_to_sgt_mapping_group
(headers=None, **query_parameters)[source]¶ This API allows the client to deploy all the IP to SGT mapping groups. Only one Deploy process can run at any given time.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_deploy_status_ip_to_sgt_mapping_group
(headers=None, **query_parameters)[source]¶ This API allows the client to get the IP to SGT mapping group deployment status. Deploy Status will show last Deploy command output. The information will be saved until the next Deploy command.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_ip_to_sgt_mapping_group_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get an IP to SGT mapping group by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_ip_to_sgt_mapping_group_by_id
-
update_ip_to_sgt_mapping_group_by_id
(id, deploy_to=None, deploy_type=None, name=None, sgt=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update an IP to SGT mapping group by ID.
- Parameters
deploy_to (string) – Mandatory unless mappingGroup is set or unless deployType=ALL, property of the request body.
deploy_type (string) – Allowed values: ALL, ND, NDG, property of the request body.
name (string) – name, property of the request body.
sgt (string) – Mandatory unless mappingGroup is set, property of the request body.
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, deploy_to=None, deploy_type=None, name=None, sgt=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_ip_to_sgt_mapping_group_by_id
-
delete_ip_to_sgt_mapping_group_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes an IP to SGT mapping group.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_ip_to_sgt_mapping_group_by_id
-
get_ip_to_sgt_mapping_group
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the IP to SGT mapping groups. Filter: [name, sgtName] To search guest users by using toDate column,follow the format: DD- MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, sgtName].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_ip_to_sgt_mapping_group
-
get_ip_to_sgt_mapping_group_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the IP to SGT mapping groups. Filter: [name, sgtName] To search guest users by using toDate column,follow the format: DD- MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, sgtName].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_ip_to_sgt_mapping_group_generator
-
create_ip_to_sgt_mapping_group
(deploy_to=None, deploy_type=None, name=None, sgt=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates an IP to SGT mapping group.
- Parameters
deploy_to (string) – Mandatory unless mappingGroup is set or unless deployType=ALL, property of the request body.
deploy_type (string) – Allowed values: ALL, ND, NDG, property of the request body.
name (string) – name, property of the request body.
sgt (string) – Mandatory unless mappingGroup is set, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(deploy_to=None, deploy_type=None, name=None, sgt=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_ip_to_sgt_mapping_group
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the IP to SGT mapping group.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
bulk_request_for_ip_to_sgt_mapping_group
(operation_type=None, resource_media_type=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to submit the bulk request.
- Parameters
operation_type (string) – operationType, property of the request body.
resource_media_type (string) – resourceMediaType, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
bulk_request
(operation_type=None, resource_media_type=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for bulk_request_for_ip_to_sgt_mapping_group
-
monitor_bulk_status_ip_to_sgt_mapping_group
(bulkid, headers=None, **query_parameters)[source]¶ This API allows the client to monitor the bulk request.
- Parameters
bulkid (basestring) – bulkid path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
identity_groups¶
-
class
IdentityGroups
[source]¶ Identity Services Engine IdentityGroups API (version: 3.1.1).
Wraps the Identity Services Engine IdentityGroups API and exposes the API as native Python methods that return native Python objects.
Identity Groups API allows the client to search identity groups.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.2
Initial Cisco ISE Version
1
1.1
2.4
Added Create and GetByName operations
Resource Definition
Attribute
Type
Required
Description
Example Values
name
String
Yes
Resource Name
GuestType_Weekly (default)
id
String
No
Resource UUID, mandatory for update
9efe2310-8c01-11e6-996c-525400b48521
description
String
No
Identity group mirroring the guest type
parent
String
Yes
NAC Group:NAC:IdentityGroups:User Identity Groups
-
get_identity_group_by_name
(name, headers=None, **query_parameters)[source]¶ This API allows the client to get an identity group by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_name
(name, headers=None, **query_parameters)[source]¶ Alias for get_identity_group_by_name
-
get_identity_group_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get an identity group by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_identity_group_by_id
-
update_identity_group_by_id
(id, description=None, name=None, parent=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update an identity group.
- Parameters
description (string) – description, property of the request body.
id (basestring) – id, property of the request body.
name (string) – name, property of the request body.
parent (string) – parent, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, description=None, name=None, parent=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_identity_group_by_id
-
get_identity_groups
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the identity groups. Filter: [name, description] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_identity_groups
-
get_identity_groups_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the identity groups. Filter: [name, description] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_identity_groups_generator
-
create_identity_group
(description=None, name=None, parent=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates an identity group.
- Parameters
description (string) – description, property of the request body.
name (string) – name, property of the request body.
parent (string) – parent, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(description=None, name=None, parent=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_identity_group
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to identity group.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
identity_sequence¶
-
class
IdentitySequence
[source]¶ Identity Services Engine IdentitySequence API (version: 3.1.1).
Wraps the Identity Services Engine IdentitySequence API and exposes the API as native Python methods that return native Python objects.
Identity Sequence API allows the client to add, delete, update and search Identity sequences.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.2
Initial Cisco ISE Version
1
1.1
2.4
Added GetByName operation
Resource Definition
Attribute
Type
Required
Description
Example Values
name
String
Yes
Resource Name
All_User_ID_Stores
id
String
No
Resource UUID, mandatory for update
93246270-8c01-11e6-996c-525400b48521
description
String
No
A built-in Identity Sequence to include all User Identity Stores
breakOnStoreFail
Boolean
Yes
Do not access other stores in the sequence If a selected identity store cannot be accessed for authentication
false
certificateAuthenticationProfile
String
Yes
Certificate Authentication Profile, empty if doesn’t exist
Preloaded_Certificate_Profile
idSeqItem
List
Yes
List of id stores comprised of id store name and order
[ { “idstore”: “Internal Users”, “order”: 1 }, { “idstore”: “All_AD_Join_Points”, “order”: 2 }, { “idstore”: “Guest Users”, “order”: 3 } ]
-
get_identity_sequence_by_name
(name, headers=None, **query_parameters)[source]¶ This API allows the client to get an identity sequence by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_name
(name, headers=None, **query_parameters)[source]¶ Alias for get_identity_sequence_by_name
-
get_identity_sequence_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get an identity sequence by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_identity_sequence_by_id
-
update_identity_sequence_by_id
(id, break_on_store_fail=None, certificate_authentication_profile=None, description=None, id_seq_item=None, name=None, parent=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update an identity sequence. Partial update is not supported.
- Parameters
break_on_store_fail (boolean) – breakOnStoreFail, property of the request body.
certificate_authentication_profile (string) – certificateAuthenticationProfile, property of the request body.
description (string) – description, property of the request body.
id (basestring) – id, property of the request body.
id_seq_item (list) – idSeqItem, property of the request body (list of objects).
name (string) – name, property of the request body.
parent (string) – parent, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, break_on_store_fail=None, certificate_authentication_profile=None, description=None, id_seq_item=None, name=None, parent=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_identity_sequence_by_id
-
delete_identity_sequence_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes an identity sequence.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_identity_sequence_by_id
-
get_identity_sequence
(page=None, size=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the identity sequences.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_identity_sequence
-
get_identity_sequence_generator
(page=None, size=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the identity sequences.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_identity_sequence_generator
-
create_identity_sequence
(break_on_store_fail=None, certificate_authentication_profile=None, description=None, id_seq_item=None, name=None, parent=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates an identity sequence.
- Parameters
break_on_store_fail (boolean) – breakOnStoreFail, property of the request body.
certificate_authentication_profile (string) – certificateAuthenticationProfile, property of the request body.
description (string) – description, property of the request body.
id_seq_item (list) – idSeqItem, property of the request body (list of objects).
name (string) – name, property of the request body.
parent (string) – parent, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(break_on_store_fail=None, certificate_authentication_profile=None, description=None, id_seq_item=None, name=None, parent=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_identity_sequence
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the identity sequence.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
internal_user¶
-
class
InternalUser
[source]¶ Identity Services Engine InternalUser API (version: 3.1.1).
Wraps the Identity Services Engine InternalUser API and exposes the API as native Python methods that return native Python objects.
Internal User API allows the client to add, delete, update and search internal users.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
Revision Modification
Revision Modification
Attribute
Description
0
1.0
2.3
Initial Cisco ISE Version
1
1.1
2.6
Support new attribute Proxy Dead Timeout
proxyTimeout
Added int Attribute ‘proxyTimeout’
Resource Definition
Attribute
Type
Required
Description
Default Values
Example Values
name
String
Yes
Resource Name
name
id
String
No
Resource UUID, mandatory for update
b24b09e2-16f8-4e48-ace1-2c262a9449f1
description
String
No
description
changePassword
Boolean
Yes
true
email
String
No
enablePassword
String
No
EnablePassword field is added in ISE 2.0 to support T+
enablePassword
enabled
Boolean
Yes
Whether the user is enabled/disabled. To use it as filter, the values should be ‘Enabled’ or ‘Disabled’. The values are case sensitive. For example, ‘[ERSObjectURL]?filter=enabled.EQ.Enabled’
true
customAttributes
String
No
Key value map
{“key1” : “value1”}
firstName
String
No
firstName
identityGroups
String
No
CSV of identity group IDs
identityGroups
lastName
String
No
lastName
password
String
No
password
passwordIDStore
String
Yes
The id store where the internal user’s password is kept
Internal Users
expiryDateEnabled
Boolean
No
false
expiryDate
String
No
To store the internal user’s expiry date information. It’s format is = ‘YYYY-MM-DD’
2021-05-19
-
get_internal_user_by_name
(name, headers=None, **query_parameters)[source]¶ This API allows the client to get an internal user by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_name
(name, headers=None, **query_parameters)[source]¶ Alias for get_internal_user_by_name
-
update_internal_user_by_name
(name, change_password=None, custom_attributes=None, description=None, email=None, enable_password=None, enabled=None, expiry_date=None, expiry_date_enabled=None, first_name=None, id=None, identity_groups=None, last_name=None, password=None, password_idstore=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update an internal user by name.
- Parameters
change_password (boolean) – changePassword, property of the request body.
custom_attributes (object) – Key value map, property of the request body.
description (string) – description, property of the request body.
email (string) – email, property of the request body.
enable_password (string) – enablePassword, property of the request body.
enabled (boolean) – Whether the user is enabled/disabled. To use it as filter, the values should be ‘Enabled’ or ‘Disabled’. The values are case sensitive. For example, ‘[ERSOb jectURL]?filter=enabled.EQ.Enabled’, property of the request body.
expiry_date (string) – To store the internal user’s expiry date information. It’s format is = ‘YYYY-MM-DD’, property of the request body.
expiry_date_enabled (boolean) – expiryDateEnabled, property of the request body.
first_name (string) – firstName, property of the request body.
id (string) – id, property of the request body.
identity_groups (string) – CSV of identity group IDs, property of the request body.
last_name (string) – lastName, property of the request body.
name (basestring) – name, property of the request body.
password (string) – password, property of the request body.
password_idstore (string) – The id store where the internal user’s password is kept, property of the request body.
name – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_name
(name, change_password=None, custom_attributes=None, description=None, email=None, enable_password=None, enabled=None, expiry_date=None, expiry_date_enabled=None, first_name=None, id=None, identity_groups=None, last_name=None, password=None, password_idstore=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_internal_user_by_name
-
delete_internal_user_by_name
(name, headers=None, **query_parameters)[source]¶ This API deletes an internal user by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_name
(name, headers=None, **query_parameters)[source]¶ Alias for delete_internal_user_by_name
-
get_internal_user_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get an internal user by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_internal_user_by_id
-
update_internal_user_by_id
(id, change_password=None, custom_attributes=None, description=None, email=None, enable_password=None, enabled=None, expiry_date=None, expiry_date_enabled=None, first_name=None, identity_groups=None, last_name=None, name=None, password=None, password_idstore=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update an internal user by ID.
- Parameters
change_password (boolean) – changePassword, property of the request body.
custom_attributes (object) – Key value map, property of the request body.
description (string) – description, property of the request body.
email (string) – email, property of the request body.
enable_password (string) – enablePassword, property of the request body.
enabled (boolean) – Whether the user is enabled/disabled. To use it as filter, the values should be ‘Enabled’ or ‘Disabled’. The values are case sensitive. For example, ‘[ERSOb jectURL]?filter=enabled.EQ.Enabled’, property of the request body.
expiry_date (string) – To store the internal user’s expiry date information. It’s format is = ‘YYYY-MM-DD’, property of the request body.
expiry_date_enabled (boolean) – expiryDateEnabled, property of the request body.
first_name (string) – firstName, property of the request body.
id (basestring) – id, property of the request body.
identity_groups (string) – CSV of identity group IDs, property of the request body.
last_name (string) – lastName, property of the request body.
name (string) – name, property of the request body.
password (string) – password, property of the request body.
password_idstore (string) – The id store where the internal user’s password is kept, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, change_password=None, custom_attributes=None, description=None, email=None, enable_password=None, enabled=None, expiry_date=None, expiry_date_enabled=None, first_name=None, identity_groups=None, last_name=None, name=None, password=None, password_idstore=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_internal_user_by_id
-
delete_internal_user_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes an internal user by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_internal_user_by_id
-
get_internal_user
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the internal users. Filter: [firstName, lastName, identityGroup, name, description, email, enabled] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_internal_user
-
get_internal_user_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the internal users. Filter: [firstName, lastName, identityGroup, name, description, email, enabled] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_internal_user_generator
-
create_internal_user
(change_password=None, custom_attributes=None, description=None, email=None, enable_password=None, enabled=None, expiry_date=None, expiry_date_enabled=None, first_name=None, identity_groups=None, last_name=None, name=None, password=None, password_idstore=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates an internal user.
- Parameters
change_password (boolean) – changePassword, property of the request body.
custom_attributes (object) – Key value map, property of the request body.
description (string) – description, property of the request body.
email (string) – email, property of the request body.
enable_password (string) – enablePassword, property of the request body.
enabled (boolean) – Whether the user is enabled/disabled. To use it as filter, the values should be ‘Enabled’ or ‘Disabled’. The values are case sensitive. For example, ‘[ERSOb jectURL]?filter=enabled.EQ.Enabled’, property of the request body.
expiry_date (string) – To store the internal user’s expiry date information. It’s format is = ‘YYYY-MM-DD’, property of the request body.
expiry_date_enabled (boolean) – expiryDateEnabled, property of the request body.
first_name (string) – firstName, property of the request body.
identity_groups (string) – CSV of identity group IDs, property of the request body.
last_name (string) – lastName, property of the request body.
name (string) – name, property of the request body.
password (string) – password, property of the request body.
password_idstore (string) – The id store where the internal user’s password is kept, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(change_password=None, custom_attributes=None, description=None, email=None, enable_password=None, enabled=None, expiry_date=None, expiry_date_enabled=None, first_name=None, identity_groups=None, last_name=None, name=None, password=None, password_idstore=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_internal_user
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the internal user.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
licensing¶
-
class
Licensing
[source]¶ Identity Services Engine Licensing API (version: 3.1.1).
Wraps the Identity Services Engine Licensing API and exposes the API as native Python methods that return native Python objects.
-
get_connection_type
(headers=None, **query_parameters)[source]¶ Get connection type.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_eval_license_info
(headers=None, **query_parameters)[source]¶ Get registration information.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_feature_to_tier_mapping
(headers=None, **query_parameters)[source]¶ Get feature to tier mapping.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(list): A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_registration_info
(headers=None, **query_parameters)[source]¶ Get registration information.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create_registration_info
(connection_type=None, registration_type=None, ssm_on_prem_server=None, tier=None, token=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ License Configure registration information.
- Parameters
connection_type (string) – connectionType, property of the request body. Available values are ‘HTTP_DIRECT’, ‘PROXY’, ‘SSM_ONPREM_SERVER’ and ‘TRANSPORT_GATEWAY’.
registration_type (string) – registrationType, property of the request body. Available values are ‘DEREGISTER’, ‘REGISTER’, ‘RENEW’ and ‘UPDATE’.
ssm_on_prem_server (string) – If connection type is selected as SSM_ONPREM_SERVER, then IP address or the hostname (or FQDN) of the SSM On-Prem server Host., property of the request body.
tier (list) – tier, property of the request body (list of strings. Available values are ‘ADVANTAGE’, ‘DEVICEADMIN’, ‘ESSENTIAL’, ‘PREMIER’ and ‘VM’).
token (string) – token, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(list): A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_smart_state
(headers=None, **query_parameters)[source]¶ Get smart license information.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
configure_smart_state
(headers=None, **query_parameters)[source]¶ License Configure smart state information.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(list): A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_tier_state_info
(headers=None, **query_parameters)[source]¶ Get tier state information.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(list): A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_tier_state_info
(headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Applicable values for name & status parameters: name: ESSENTIAL, ADVANTAGE, PREMIER, DEVICEADMIN status: ENABLED, DISABLED .
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (list) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
mdm¶
-
class
Mdm
[source]¶ Identity Services Engine MDM API (version: 3.1.1).
Wraps the Identity Services Engine MDM API and exposes the API as native Python methods that return native Python objects.
# Cisco ISE 3.0 pxGrid REST APIs
## License [Cisco Sample Code License](https://developer.cisco.com/site/license/cisco-sample-code-license/)
## Status These are the status icons for the requests so far. - ⌗ : must create resources to test - 🚧 : incomplete | untested - 🛑 : unsupported | bug
## Environment Variables This collection uses environment variables in scripts in the Tests tab to store data (id, name, portalId, etc.) between requests. This allows you to GET or POST then immediately GET {id} on a resource. Using No Environment will cause this convenience functionality to fail so be sure to choose one.
## Collection Variables This collection includes some default variables that you will want to update or override with environment variables for your ISE deployment. Specifically, you will want to set: - ise_pxg: the ISE PAN node name or IP address. Default: ise.securitydemo.net - rest_username: the username for ERS API access. Must be a member of SuperAdmin, ERSAdmin or ERSOperator groups. Default: admin which is the ISE SuperAdmin - rest_password: Default: C1sco12345
-
get_endpoints
(headers=None, **query_parameters)[source]¶ 🚧 getEndpoints.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(headers=None, **query_parameters)[source]¶ Alias for get_endpoints
-
get_endpoint_by_mac_address
(headers=None, **query_parameters)[source]¶ 🚧 getEndpointByMacAddress.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_endpoints_by_type
(headers=None, **query_parameters)[source]¶ 🚧 getEndpointsByType.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_endpoints_by_os_type
(headers=None, **query_parameters)[source]¶ 🚧 getEndpointsByOsType.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
misc¶
-
class
Misc
[source]¶ Identity Services Engine Misc API (version: 3.1.1).
Wraps the Identity Services Engine Misc API and exposes the API as native Python methods that return native Python objects.
# Cisco ISE 3.0 MNT REST APIs
## License [Cisco Sample Code License](https://developer.cisco.com/site/license/cisco-sample-code-license/)
## Status These are the status icons for the requests so far. - ⌗ : must create resources to test - 🚧 : incomplete | untested - 🛑 : unsupported | bug
## Environment Variables This collection uses environment variables in scripts in the Tests tab to store data (id, name, portalId, etc.) between requests. This allows you to GET or POST then immediately GET {id} on a resource. Using No Environment will cause this convenience functionality to fail so be sure to choose one.
## Collection Variables This collection includes some default variables that you will want to update or override with environment variables for your ISE deployment. Specfically, you will want to set: - ise_mnt: the ISE PAN node name or IP address. Default: ise.securitydemo.net - rest_username: the username for ERS API access. Must be a member of SuperAdmin, ERSAdmin or ERSOperator groups. Default: admin which is the ISE SuperAdmin - rest_password: Default: C1sco12345
-
get_active_count
(headers=None, **query_parameters)[source]¶ ActiveCount.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_active_list
(headers=None, **query_parameters)[source]¶ ActiveList.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_session_auth_list
(headers=None, **query_parameters)[source]¶ Session/AuthList.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_posture_count
(headers=None, **query_parameters)[source]¶ PostureCount.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_profiler_count
(headers=None, **query_parameters)[source]¶ ProfilerCount.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_sessions_by_mac
(mac, headers=None, **query_parameters)[source]¶ Sessions by MAC.
- Parameters
mac (basestring) – mac path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_sessions_by_username
(username, headers=None, **query_parameters)[source]¶ Sessions by Username.
- Parameters
username (basestring) – username path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_sessions_by_nas_ip
(nas_ipv4, headers=None, **query_parameters)[source]¶ Sessions by NAS IP.
- Parameters
nas_ipv4 (basestring) – nas_ipv4 path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_sessions_by_endpoint_ip
(endpoint_ipv4, headers=None, **query_parameters)[source]¶ Sessions by Endpoint IP.
- Parameters
endpoint_ipv4 (basestring) – endpoint_ipv4 path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_sessions_by_session_id
(session_id, headers=None, **query_parameters)[source]¶ Sessions by SessionID.
- Parameters
session_id (basestring) – session_id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_all_sessions
(headers=None, **query_parameters)[source]¶ Delete All Sessions.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_mnt_version
(headers=None, **query_parameters)[source]¶ MNT Version.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_failure_reasons
(headers=None, **query_parameters)[source]¶ FailureReasons.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_authentication_status_by_mac
(mac, rec_ord_s, sec_ond_s, headers=None, **query_parameters)[source]¶ AuthenticationStatus by MAC.
- Parameters
mac (basestring) – MAC path parameter.
sec_ond_s (basestring) – SECONDS path parameter.
rec_ord_s (basestring) – RECORDS path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
session_reauthentication_by_mac
(end_poi_ntm_ac, psn_nam_e, rea_uth_typ_e, headers=None, **query_parameters)[source]¶ Session Reauthentication by MAC.
- Parameters
psn_nam_e (basestring) – PSN_NAME path parameter.
end_poi_ntm_ac (basestring) – ENDPOINT_MAC path parameter.
rea_uth_typ_e (basestring) – REAUTH_TYPE path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
session_disconnect
(dis_con_nec_tty_pe, end_poi_nti_p, mac, nas_ipv4, psn_nam_e, headers=None, **query_parameters)[source]¶ Session Disconnect.
- Parameters
end_poi_nti_p (basestring) – ENDPOINT_IP path parameter.
psn_nam_e (basestring) – PSN_NAME path parameter.
mac (basestring) – MAC path parameter.
dis_con_nec_tty_pe (basestring) – DISCONNECT_TYPE path parameter.
nas_ipv4 (basestring) – NAS_IPV4 path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_account_status_by_mac
(duration, mac, headers=None, **query_parameters)[source]¶ AccountStatus by MAC.
- Parameters
mac (basestring) – mac path parameter.
duration (basestring) – duration path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
my_device_portal¶
-
class
MyDevicePortal
[source]¶ Identity Services Engine MyDevicePortal API (version: 3.1.1).
Wraps the Identity Services Engine MyDevicePortal API and exposes the API as native Python methods that return native Python objects.
My Device Portal API provides the ability to create, read, update, delete and search my device portals.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.2
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Default Values
Example Values
name
String
Yes
Resource Name
My Devices Portal (default)
id
String
No
Resource UUID, mandatory for update
901f1b37-4a2f-46d9-8653-d925d2dde3aa
description
String
No
Default portal used by employees to register and manage their personal devices
portalTestUrl
String
No
URL to bring up a test page for this portal
https://{ise-ip}:8443/mydevicesportal/PortalSetup.action?portal=901f1b37-4a2f-46d9-8653-d925d2dde3aa
portalType
Enum
Yes
Allowed values: BYOD, HOTSPOTGUEST, MYDEVICE, SELFREGGUEST, SPONSOR, SPONSOREDGUEST
MYDEVICE
settings
List
No
Defines all of the settings groups available for a Mydevice portal
portalSettings
List
No
The port, interface, certificate, and other basic settings of a portal
httpsPort
Integer
Yes
The port number that the allowed interfaces will listen on. Range from 8000 to 8999
8443
allowedInterfaces
Enum
Yes
Interfaces that the portal will be reachable on. Allowed values: eth0, eth1, eth2, eth3, eth4, eth5, bond0, bond1, bond2
[ “eth0”, “bond0” ]
certificateGroupTag
String
Yes
Logical name of the x.509 server certificate that will be used for the portal
Default Portal Certificate Group
endpointIdentityGroup
String
Yes
Unique Id of the endpoint identity group where user’s devices will be added. Used only in Hotspot Portal
aa178bd0-8bff-11e6-996c-525400b48521
displayLang
Enum
No
Allowed values: USEBROWSERLOCALE, ALWAYSUSE
USEBROWSERLOCALE
fallbackLanguage
String
No
Used when displayLang = USEBROWSERLOCALE
English
alwaysUsedLanguage
String
No
Used when displayLang = ALWAYSUSE
English
loginPageSettings
List
No
Portal Login Page settings groups follow
maxFailedAttemptsBeforeRateLimit
Integer
No
Maximum failed login attempts before rate limiting
5
timeBetweenLoginsDuringRateLimit
Integer
No
2
includeAup
Boolean
No
Include an Acceptable Use Policy (AUP) that should be displayed during login
false
aupDisplay
Enum
No
How the AUP should be displayed, either on page or as a link. Only valid if includeAup = true. Allowed values: ONPAGE, ASLINK - ONPAGE, - ASLINK
ASLINK
requireAupAcceptance
Boolean
No
Require the portal user to accept the AUP. Only valid if includeAup = true
false
requireScrolling
Boolean
No
Require the portal user to scroll to the end of the AUP. Only valid if requireAupAcceptance = true
false
aupSettings
List
No
Configuration of the Acceptable Use Policy (AUP) for a portal
displayFrequency
Enum
No
How the AUP should be displayed, either on page or as a link. Only valid if includeAup = true.
FIRSTLOGIN
includeAup
Boolean
No
Require the portal user to read and accept an AUP
true
requireScrolling
Boolean
No
Require the portal user to scroll to the end of the AUP. Only valid if requireAupAcceptance = true
false
displayFrequencyIntervalDays
Integer
No
Number of days between AUP confirmations (when displayFrequency = recurring)
7
employeeChangePasswordSettings
List
No
allowEmployeeToChangePwd
Boolean
No
Allow employees to change their own passwords
false
postLoginBannerSettings
List
No
includePostAccessBanner
Boolean
No
Include a Post-Login Banner page
false
supportInfoSettings
List
No
Portal Support Information Settings
includeSupportInfoPage
Boolean
No
false
includeMacAddr
Boolean
No
false
includeIpAddress
Boolean
No
false
includeBrowserUserAgent
Boolean
No
false
includePolicyServer
Boolean
No
false
includeFailureCode
Boolean
No
false
emptyFieldDisplay
Enum
No
Specifies how empty fields are handled on the Support Information Page.
HIDE
defaultEmptyFieldValue
String
No
The default value displayed for an empty field Only valid when emptyFieldDisplay = DISPLAYWITHDEFAULTVALUE
customizations
List
No
Defines all of the Portal Customizations available
portalTheme
List
No
Defines the configuration for portal theme
id
String
No
The unique internal identifier of the portal theme
9eb421c0-8c01-11e6-996c-525400b48521
name
String
Yes
The system- or user-assigned name of the portal theme
Default Blue theme
themeData
String
No
A CSS file, represented as a Base64-encoded byte array
Base 64 encoded string of Theme CSS file
portalTweakSettings
List
No
The Tweak Settings are a customization of the Portal Theme that has been selected for the portal. When the Portal Theme selection is changed, the Tweak Settings are overwritten to match the values in the theme. The Tweak Settings can subsequently be changed by the user
bannerColor
String
No
Hex value of color
#0000FF
bannerTextColor
String
No
Banner Text color code from GUI
pageBackgroundColor
String
No
Color code from GUI
pageLabelAndTextColor
String
No
Label and Text color from GUI
language
List
No
This property is supported only for Read operation and it allows to show the customizations in English. Other languages are not supported
viewLanguage
String
No
English
globalCustomizations
List
No
Represent the portal Global customizations
bannerTitle
String
No
My Devices Portal
contactText
String
No
Contact Support
footerElement
String
No
Footer Element
mobileLogoImage
Image
No
data
String
No
Represented as base 64 encoded string of the image byte array
base 64 encoded value of image
desktopLogoImage
Image
No
data
String
No
Represented as base 64 encoded string of the image byte array
base 64 encoded value of image
bannerImage
Image
No
data
String
No
Represented as base 64 encoded string of the image byte array
base 64 encoded value of image
backgroundImage
Image
No
data
String
No
Represented as base 64 encoded string of the image byte array
base 64 encoded value of image
pageCustomizations
List
No
Represent the entire page customization as a giant dictionary
data
List
No
The Dictionary will be exposed here as key value pair
key
String
Yes
ui_contact_ip_address_label
value
String
Yes
SVAgYWRkcmVzczo=
-
get_my_device_portal_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get a my device portal by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_my_device_portal_by_id
-
update_my_device_portal_by_id
(id, customizations=None, description=None, name=None, portal_test_url=None, portal_type=None, settings=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update a my device portal by ID.
- Parameters
customizations (object) – Defines all of the Portal Customizations available, property of the request body.
description (string) – description, property of the request body.
id (basestring) – id, property of the request body.
name (string) – name, property of the request body.
portal_test_url (string) – URL to bring up a test page for this portal, property of the request body.
portal_type (string) – Allowed values: BYOD, HOTSPOTGUEST, MYDEVICE, SELFREGGUEST, SPONSOR, SPONSOREDGUEST, property of the request body.
settings (object) – Defines all of the settings groups available for a Mydevice portal, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, customizations=None, description=None, name=None, portal_test_url=None, portal_type=None, settings=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_my_device_portal_by_id
-
delete_my_device_portal_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes a my device portal by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_my_device_portal_by_id
-
get_my_device_portal
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the my device portals. Filter: [name, description] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_my_device_portal
-
get_my_device_portal_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the my device portals. Filter: [name, description] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_my_device_portal_generator
-
create_my_device_portal
(customizations=None, description=None, name=None, portal_test_url=None, portal_type=None, settings=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates a my device portal.
- Parameters
customizations (object) – Defines all of the Portal Customizations available, property of the request body.
description (string) – description, property of the request body.
name (string) – name, property of the request body.
portal_test_url (string) – URL to bring up a test page for this portal, property of the request body.
portal_type (string) – Allowed values: BYOD, HOTSPOTGUEST, MYDEVICE, SELFREGGUEST, SPONSOR, SPONSOREDGUEST, property of the request body.
settings (object) – Defines all of the settings groups available for a Mydevice portal, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(customizations=None, description=None, name=None, portal_test_url=None, portal_type=None, settings=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_my_device_portal
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the my device portal.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
native_supplicant_profile¶
-
class
NativeSupplicantProfile
[source]¶ Identity Services Engine NativeSupplicantProfile API (version: 3.1.1).
Wraps the Identity Services Engine NativeSupplicantProfile API and exposes the API as native Python methods that return native Python objects.
Native supplicant profile API provides the ability to update, delete and search native supplicant profiles.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.2
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Example Values
name
String
Yes
Resource Name
Cisco-ISE-NSP
id
String
No
Resource UUID, mandatory for update
b8ce01e6-b150-4d4e-9698-40e48d5e0197
description
String
No
Pre-configured Native Supplicant Profile. The SSID Will Need To Be Customized For Your Environment
wirelessProfiles
List
Yes
List of Wireless profiles
ssid
String
Yes
SSID for the wireless profile
ISE
allowedProtocol
Enum
Yes
Allowed protocol for the wireless profile.
TLS
certificateTemplateId
String
No
Certificate template ID
0ca8f1b6-500d-560b-e053-75189a0ab0d1
actionType
Enum
Yes
Action type for WifiProfile.
UPDATE
previousSsid
String
Yes
Previous ssid for WifiProfile (required for updating existing WirelessProfile)
ssid1
-
get_native_supplicant_profile_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get a native supplicant profile by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_native_supplicant_profile_by_id
-
update_native_supplicant_profile_by_id
(id, description=None, name=None, wireless_profiles=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update a native supplicant profile.
- Parameters
description (string) – description, property of the request body.
id (basestring) – id, property of the request body.
name (string) – name, property of the request body.
wireless_profiles (list) – wirelessProfiles, property of the request body (list of objects).
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, description=None, name=None, wireless_profiles=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_native_supplicant_profile_by_id
-
delete_native_supplicant_profile_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes a native supplicant profile.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_native_supplicant_profile_by_id
-
get_native_supplicant_profile
(page=None, size=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the native supplicant profiles.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_native_supplicant_profile
-
get_native_supplicant_profile_generator
(page=None, size=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the native supplicant profiles.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_native_supplicant_profile_generator
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the native supplicant profile.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
network_access_authentication_rules¶
-
class
NetworkAccessAuthenticationRules
[source]¶ Identity Services Engine Network Access - Authentication Rules API (version: 3.1.1).
Wraps the Identity Services Engine Network Access - Authentication Rules API and exposes the API as native Python methods that return native Python objects.
-
get_network_access_authentication_rules
(policy_id, headers=None, **query_parameters)[source]¶ Network Access Get authentication rules.
- Parameters
policy_id (basestring) – policyId path parameter. Policy id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(policy_id, headers=None, **query_parameters)[source]¶ Alias for get_network_access_authentication_rules
-
create_network_access_authentication_rule
(policy_id, identity_source_name=None, if_auth_fail=None, if_process_fail=None, if_user_not_found=None, link=None, rule=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Network Access Create authentication rule: Rule must include name and condition. Condition has hierarchical structure which define a set of conditions for which authentication policy rule could be match. Condition can be either reference to a stored Library condition, using model ConditionReference or dynamically built conditions which are not stored in the conditions Library, using models ConditionAttributes, ConditionAndBlock, ConditionOrBlock . .
- Parameters
identity_source_name (string) – Identity source name from the identity stores, property of the request body.
if_auth_fail (string) – Action to perform when authentication fails such as Bad credentials, disabled user and so on, property of the request body.
if_process_fail (string) – Action to perform when ISE is uanble to access the identity database, property of the request body.
if_user_not_found (string) – Action to perform when user is not found in any of identity stores, property of the request body.
link (object) – link, property of the request body.
rule (object) – Common attributes in rule authentication/authorization, property of the request body.
policy_id (basestring) – policyId path parameter. Policy id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(policy_id, identity_source_name=None, if_auth_fail=None, if_process_fail=None, if_user_not_found=None, link=None, rule=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
-
reset_hit_counts_network_access_authentication_rules
(policy_id, headers=None, **query_parameters)[source]¶ Network Access Reset HitCount for Authentication Rules.
- Parameters
policy_id (basestring) – policyId path parameter. Policy id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
reset_hit_counts_by_id
(policy_id, headers=None, **query_parameters)[source]¶ Alias for reset_hit_counts_network_access_authentication_rules
-
get_network_access_authentication_rule_by_id
(id, policy_id, headers=None, **query_parameters)[source]¶ Network Access Get rule attributes.
- Parameters
policy_id (basestring) – policyId path parameter. Policy id.
id (basestring) – id path parameter. Rule id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_network_access_authentication_rule_by_id
(id, policy_id, identity_source_name=None, if_auth_fail=None, if_process_fail=None, if_user_not_found=None, link=None, rule=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Network Access Update rule.
- Parameters
identity_source_name (string) – Identity source name from the identity stores, property of the request body.
if_auth_fail (string) – Action to perform when authentication fails such as Bad credentials, disabled user and so on, property of the request body.
if_process_fail (string) – Action to perform when ISE is uanble to access the identity database, property of the request body.
if_user_not_found (string) – Action to perform when user is not found in any of identity stores, property of the request body.
link (object) – link, property of the request body.
rule (object) – Common attributes in rule authentication/authorization, property of the request body.
policy_id (basestring) – policyId path parameter. Policy id.
id (basestring) – id path parameter. Rule id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, policy_id, identity_source_name=None, if_auth_fail=None, if_process_fail=None, if_user_not_found=None, link=None, rule=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
-
delete_network_access_authentication_rule_by_id
(id, policy_id, headers=None, **query_parameters)[source]¶ Network Access Delete rule.
- Parameters
policy_id (basestring) – policyId path parameter. Policy id.
id (basestring) – id path parameter. Rule id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
network_access_conditions¶
-
class
NetworkAccessConditions
[source]¶ Identity Services Engine Network Access - Conditions API (version: 3.1.1).
Wraps the Identity Services Engine Network Access - Conditions API and exposes the API as native Python methods that return native Python objects.
-
get_network_access_conditions
(headers=None, **query_parameters)[source]¶ Network Access Returns all library conditions.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(headers=None, **query_parameters)[source]¶ Alias for get_network_access_conditions
-
create_network_access_condition
(attribute_name=None, attribute_value=None, children=None, condition_type=None, dates_range=None, dates_range_exception=None, description=None, dictionary_name=None, dictionary_value=None, hours_range=None, hours_range_exception=None, id=None, is_negate=None, link=None, name=None, operator=None, week_days=None, week_days_exception=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Network Access Creates a library condition: Library Condition has hierarchical structure which define a set of condition for which authentication and authorization policy rules could be match. Condition can be compose from single dictionary attribute name and value using model LibraryConditionAttributes , or from combination of dictionary attributes with logical operation of AND/OR between them, using models: LibraryConditionAndBlock or LibraryConditionOrBlock . When using AND/OR blocks, the condition will include inner layers inside these blocks, these layers are built using the inner condition models: ConditionAttributes , ConditionAndBlock , ConditionOrBlock , that represent dynamically built Conditions which are not stored in the conditions Library, or using ConditionReference , which includes an ID to existing stored condition in the library. The LibraryCondition models can only be used in the outer-most layer (root of the condition) and must always include the condition name. When using one of the 3 inner condition models ( ConditionAttributes, ConditionAndBlock, ConditionOrBlock ), condition name cannot be included in the request, since these will not be stored in the conditions library, and used only as inner members of the root condition. When using ConditionReference model in inner layers, the condition name is not required. ConditionReference objects can also include a reference ID to a condition of type TimeAndDate . .
- Parameters
attribute_name (string) – Dictionary attribute name, property of the request body.
attribute_value (string) – Attribute value for condition Value type is specified in dictionary object if multiple values allowed is specified in dictionary object, property of the request body.
children (list) – In case type is andBlock or orBlock addtional conditions will be aggregated under this logical (OR/AND) condition, property of the request body (list of objects).
condition_type (string) – Inidicates whether the record is the condition itself(data) or a logical(or,and) aggregation Data type enum(reference,single) indicates than “conditonId” OR “ConditionAttrs” fields should contain condition data but not both Logical aggreation(and,or) enum indicates that additional conditions are present under the children field, property of the request body. Available values are ‘ConditionAndBlock’, ‘ConditionAttributes’, ‘ConditionOrBlock’, ‘ConditionReference’, ‘LibraryConditionAndBlock’, ‘LibraryConditionAttributes’, ‘LibraryConditionOrBlock’ and ‘TimeAndDateCondition’.
dates_range (object) – Defines for which date/s TimeAndDate condition will be matched Options are Date range, for specific date, the same date should be used for start/end date Default no specific dates In order to reset the dates to have no specific dates Date format yyyy- mm-dd (MM = month, dd = day, yyyy = year), property of the request body.
dates_range_exception (object) – Defines for which date/s TimeAndDate condition will be matched Options are Date range, for specific date, the same date should be used for start/end date Default no specific dates In order to reset the dates to have no specific dates Date format yyyy- mm-dd (MM = month, dd = day, yyyy = year), property of the request body.
description (string) – Condition description, property of the request body.
dictionary_name (string) – Dictionary name, property of the request body.
dictionary_value (string) – Dictionary value, property of the request body.
hours_range (object) – Defines for which hours a TimeAndDate condition will be matched Time format hh:mm ( h = hour , mm = minutes ) Default All Day , property of the request body.
hours_range_exception (object) – Defines for which hours a TimeAndDate condition will be matched Time format hh:mm ( h = hour , mm = minutes ) Default All Day , property of the request body.
id (string) – id, property of the request body.
is_negate (boolean) – Indicates whereas this condition is in negate mode, property of the request body.
link (object) – link, property of the request body.
name (string) – Condition name, property of the request body.
operator (string) – Equality operator, property of the request body. Available values are ‘contains’, ‘endsWith’, ‘equals’, ‘greaterOrEquals’, ‘greaterThan’, ‘in’, ‘ipEquals’, ‘ipGreaterThan’, ‘ipLessThan’, ‘ipNotEquals’, ‘lessOrEquals’, ‘lessThan’, ‘matches’, ‘notContains’, ‘notEndsWith’, ‘notEquals’, ‘notIn’, ‘notStartsWith’ and ‘startsWith’.
week_days (list) – Defines for which days this condition will be matched Days format Arrays of WeekDay enums Default List of All week days, property of the request body (list of strings. Available values are ‘Friday’, ‘Monday’, ‘Saturday’, ‘Sunday’, ‘Thursday’, ‘Tuesday’ and ‘Wednesday’).
week_days_exception (list) – Defines for which days this condition will NOT be matched Days format Arrays of WeekDay enums Default Not enabled, property of the request body (list of strings. Available values are ‘Friday’, ‘Monday’, ‘Saturday’, ‘Sunday’, ‘Thursday’, ‘Tuesday’ and ‘Wednesday’).
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(attribute_name=None, attribute_value=None, children=None, condition_type=None, dates_range=None, dates_range_exception=None, description=None, dictionary_name=None, dictionary_value=None, hours_range=None, hours_range_exception=None, id=None, is_negate=None, link=None, name=None, operator=None, week_days=None, week_days_exception=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_network_access_condition
-
get_network_access_conditions_for_authentication_rules
(headers=None, **query_parameters)[source]¶ Network Access Returns list of library conditions for Authentication rules scope.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
Network Access Returns list of library conditions for Authorization rules scope.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_network_access_condition_by_name
(name, headers=None, **query_parameters)[source]¶ Network Access Returns a library condition.
- Parameters
name (basestring) – name path parameter. Condition name.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_name
(name, headers=None, **query_parameters)[source]¶ Alias for get_network_access_condition_by_name
-
update_network_access_condition_by_name
(name, attribute_name=None, attribute_value=None, children=None, condition_type=None, dates_range=None, dates_range_exception=None, description=None, dictionary_name=None, dictionary_value=None, hours_range=None, hours_range_exception=None, id=None, is_negate=None, link=None, operator=None, week_days=None, week_days_exception=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Network Access Update library condition using condition name.
- Parameters
attribute_name (string) – Dictionary attribute name, property of the request body.
attribute_value (string) – Attribute value for condition Value type is specified in dictionary object if multiple values allowed is specified in dictionary object, property of the request body.
children (list) – In case type is andBlock or orBlock addtional conditions will be aggregated under this logical (OR/AND) condition, property of the request body (list of objects).
condition_type (string) – Inidicates whether the record is the condition itself(data) or a logical(or,and) aggregation Data type enum(reference,single) indicates than “conditonId” OR “ConditionAttrs” fields should contain condition data but not both Logical aggreation(and,or) enum indicates that additional conditions are present under the children field, property of the request body. Available values are ‘ConditionAndBlock’, ‘ConditionAttributes’, ‘ConditionOrBlock’, ‘ConditionReference’, ‘LibraryConditionAndBlock’, ‘LibraryConditionAttributes’, ‘LibraryConditionOrBlock’ and ‘TimeAndDateCondition’.
dates_range (object) – Defines for which date/s TimeAndDate condition will be matched Options are Date range, for specific date, the same date should be used for start/end date Default no specific dates In order to reset the dates to have no specific dates Date format yyyy- mm-dd (MM = month, dd = day, yyyy = year), property of the request body.
dates_range_exception (object) – Defines for which date/s TimeAndDate condition will be matched Options are Date range, for specific date, the same date should be used for start/end date Default no specific dates In order to reset the dates to have no specific dates Date format yyyy- mm-dd (MM = month, dd = day, yyyy = year), property of the request body.
description (string) – Condition description, property of the request body.
dictionary_name (string) – Dictionary name, property of the request body.
dictionary_value (string) – Dictionary value, property of the request body.
hours_range (object) – Defines for which hours a TimeAndDate condition will be matched Time format hh:mm ( h = hour , mm = minutes ) Default All Day , property of the request body.
hours_range_exception (object) – Defines for which hours a TimeAndDate condition will be matched Time format hh:mm ( h = hour , mm = minutes ) Default All Day , property of the request body.
id (string) – id, property of the request body.
is_negate (boolean) – Indicates whereas this condition is in negate mode, property of the request body.
link (object) – link, property of the request body.
name (basestring) – Condition name, property of the request body.
operator (string) – Equality operator, property of the request body. Available values are ‘contains’, ‘endsWith’, ‘equals’, ‘greaterOrEquals’, ‘greaterThan’, ‘in’, ‘ipEquals’, ‘ipGreaterThan’, ‘ipLessThan’, ‘ipNotEquals’, ‘lessOrEquals’, ‘lessThan’, ‘matches’, ‘notContains’, ‘notEndsWith’, ‘notEquals’, ‘notIn’, ‘notStartsWith’ and ‘startsWith’.
week_days (list) – Defines for which days this condition will be matched Days format Arrays of WeekDay enums Default List of All week days, property of the request body (list of strings. Available values are ‘Friday’, ‘Monday’, ‘Saturday’, ‘Sunday’, ‘Thursday’, ‘Tuesday’ and ‘Wednesday’).
week_days_exception (list) – Defines for which days this condition will NOT be matched Days format Arrays of WeekDay enums Default Not enabled, property of the request body (list of strings. Available values are ‘Friday’, ‘Monday’, ‘Saturday’, ‘Sunday’, ‘Thursday’, ‘Tuesday’ and ‘Wednesday’).
name – name path parameter. Condition name.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_name
(name, attribute_name=None, attribute_value=None, children=None, condition_type=None, dates_range=None, dates_range_exception=None, description=None, dictionary_name=None, dictionary_value=None, hours_range=None, hours_range_exception=None, id=None, is_negate=None, link=None, operator=None, week_days=None, week_days_exception=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_network_access_condition_by_name
-
delete_network_access_condition_by_name
(name, headers=None, **query_parameters)[source]¶ Network Access Delete a library condition using condition Name.
- Parameters
name (basestring) – name path parameter. Condition name.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_name
(name, headers=None, **query_parameters)[source]¶ Alias for delete_network_access_condition_by_name
-
get_network_access_conditions_for_policy_sets
(headers=None, **query_parameters)[source]¶ Network Access Returns list of library conditions for PolicySet scope.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_network_access_condition_by_id
(id, headers=None, **query_parameters)[source]¶ Network Access Returns a library condition.
- Parameters
id (basestring) – id path parameter. Condition id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_network_access_condition_by_id
-
update_network_access_condition_by_id
(id, attribute_name=None, attribute_value=None, children=None, condition_type=None, dates_range=None, dates_range_exception=None, description=None, dictionary_name=None, dictionary_value=None, hours_range=None, hours_range_exception=None, is_negate=None, link=None, name=None, operator=None, week_days=None, week_days_exception=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Network Access Update library condition.
- Parameters
attribute_name (string) – Dictionary attribute name, property of the request body.
attribute_value (string) – Attribute value for condition Value type is specified in dictionary object if multiple values allowed is specified in dictionary object, property of the request body.
children (list) – In case type is andBlock or orBlock addtional conditions will be aggregated under this logical (OR/AND) condition, property of the request body (list of objects).
condition_type (string) – Inidicates whether the record is the condition itself(data) or a logical(or,and) aggregation Data type enum(reference,single) indicates than “conditonId” OR “ConditionAttrs” fields should contain condition data but not both Logical aggreation(and,or) enum indicates that additional conditions are present under the children field, property of the request body. Available values are ‘ConditionAndBlock’, ‘ConditionAttributes’, ‘ConditionOrBlock’, ‘ConditionReference’, ‘LibraryConditionAndBlock’, ‘LibraryConditionAttributes’, ‘LibraryConditionOrBlock’ and ‘TimeAndDateCondition’.
dates_range (object) – Defines for which date/s TimeAndDate condition will be matched Options are Date range, for specific date, the same date should be used for start/end date Default no specific dates In order to reset the dates to have no specific dates Date format yyyy- mm-dd (MM = month, dd = day, yyyy = year), property of the request body.
dates_range_exception (object) – Defines for which date/s TimeAndDate condition will be matched Options are Date range, for specific date, the same date should be used for start/end date Default no specific dates In order to reset the dates to have no specific dates Date format yyyy- mm-dd (MM = month, dd = day, yyyy = year), property of the request body.
description (string) – Condition description, property of the request body.
dictionary_name (string) – Dictionary name, property of the request body.
dictionary_value (string) – Dictionary value, property of the request body.
hours_range (object) – Defines for which hours a TimeAndDate condition will be matched Time format hh:mm ( h = hour , mm = minutes ) Default All Day , property of the request body.
hours_range_exception (object) – Defines for which hours a TimeAndDate condition will be matched Time format hh:mm ( h = hour , mm = minutes ) Default All Day , property of the request body.
id (basestring) – id, property of the request body.
is_negate (boolean) – Indicates whereas this condition is in negate mode, property of the request body.
link (object) – link, property of the request body.
name (string) – Condition name, property of the request body.
operator (string) – Equality operator, property of the request body. Available values are ‘contains’, ‘endsWith’, ‘equals’, ‘greaterOrEquals’, ‘greaterThan’, ‘in’, ‘ipEquals’, ‘ipGreaterThan’, ‘ipLessThan’, ‘ipNotEquals’, ‘lessOrEquals’, ‘lessThan’, ‘matches’, ‘notContains’, ‘notEndsWith’, ‘notEquals’, ‘notIn’, ‘notStartsWith’ and ‘startsWith’.
week_days (list) – Defines for which days this condition will be matched Days format Arrays of WeekDay enums Default List of All week days, property of the request body (list of strings. Available values are ‘Friday’, ‘Monday’, ‘Saturday’, ‘Sunday’, ‘Thursday’, ‘Tuesday’ and ‘Wednesday’).
week_days_exception (list) – Defines for which days this condition will NOT be matched Days format Arrays of WeekDay enums Default Not enabled, property of the request body (list of strings. Available values are ‘Friday’, ‘Monday’, ‘Saturday’, ‘Sunday’, ‘Thursday’, ‘Tuesday’ and ‘Wednesday’).
id – id path parameter. Condition id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, attribute_name=None, attribute_value=None, children=None, condition_type=None, dates_range=None, dates_range_exception=None, description=None, dictionary_name=None, dictionary_value=None, hours_range=None, hours_range_exception=None, is_negate=None, link=None, name=None, operator=None, week_days=None, week_days_exception=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_network_access_condition_by_id
-
delete_network_access_condition_by_id
(id, headers=None, **query_parameters)[source]¶ Network Access Delete a library condition.
- Parameters
id (basestring) – id path parameter. Condition id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_network_access_condition_by_id
-
network_access_dictionary¶
-
class
NetworkAccessDictionary
[source]¶ Identity Services Engine Network Access - Dictionary API (version: 3.1.1).
Wraps the Identity Services Engine Network Access - Dictionary API and exposes the API as native Python methods that return native Python objects.
-
get_network_access_dictionaries
(headers=None, **query_parameters)[source]¶ Get all Dictionaries.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(headers=None, **query_parameters)[source]¶ Alias for get_network_access_dictionaries
-
create_network_access_dictionaries
(description=None, dictionary_attr_type=None, id=None, link=None, name=None, version=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Network Access Create a new Dictionary.
- Parameters
description (string) – The description of the Dictionary, property of the request body.
dictionary_attr_type (string) – The dictionary attribute type, property of the request body. Available values are ‘ENTITY_ATTR’, ‘MSG_ATTR’ and ‘PIP_ATTR’.
id (string) – Identifier for the dictionary, property of the request body.
link (object) – link, property of the request body.
name (string) – The dictionary name, property of the request body.
version (string) – The dictionary version, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(description=None, dictionary_attr_type=None, id=None, link=None, name=None, version=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_network_access_dictionaries
-
get_network_access_dictionary_by_name
(name, headers=None, **query_parameters)[source]¶ GET a dictionary by name.
- Parameters
name (basestring) – name path parameter. the dictionary name.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_name
(name, headers=None, **query_parameters)[source]¶ Alias for get_network_access_dictionary_by_name
-
update_network_access_dictionary_by_name
(name, description=None, dictionary_attr_type=None, id=None, link=None, version=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Network Access Update a Dictionary.
- Parameters
description (string) – The description of the Dictionary, property of the request body.
dictionary_attr_type (string) – The dictionary attribute type, property of the request body. Available values are ‘ENTITY_ATTR’, ‘MSG_ATTR’ and ‘PIP_ATTR’.
id (string) – Identifier for the dictionary, property of the request body.
link (object) – link, property of the request body.
name (basestring) – The dictionary name, property of the request body.
version (string) – The dictionary version, property of the request body.
name – name path parameter. the dictionary name.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_name
(name, description=None, dictionary_attr_type=None, id=None, link=None, version=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_network_access_dictionary_by_name
-
delete_network_access_dictionary_by_name
(name, headers=None, **query_parameters)[source]¶ Network Access Delete a Dictionary.
- Parameters
name (basestring) – name path parameter. the dictionary name.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_name
(name, headers=None, **query_parameters)[source]¶ Alias for delete_network_access_dictionary_by_name
-
network_access_dictionary_attribute¶
-
class
NetworkAccessDictionaryAttribute
[source]¶ Identity Services Engine Network Access - Dictionary Attribute API (version: 3.1.1).
Wraps the Identity Services Engine Network Access - Dictionary Attribute API and exposes the API as native Python methods that return native Python objects.
-
get_network_access_dictionary_attributes_by_dictionary_name
(dictionary_name, headers=None, **query_parameters)[source]¶ Returns a list of Dictionary Attributes for an existing Dictionary.
- Parameters
dictionary_name (basestring) – dictionaryName path parameter. the name of the dictionary the dictionary attribute belongs to.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(dictionary_name, headers=None, **query_parameters)[source]¶ Alias for get_network_access_dictionary_attributes_by_dictionary_name
-
create_network_access_dictionary_attribute
(dictionary_name, allowed_values=None, data_type=None, description=None, direction_type=None, id=None, internal_name=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Create a new Dictionary Attribute for an existing Dictionary.
- Parameters
allowed_values (list) – all of the allowed values for the dictionary attribute, property of the request body (list of objects).
data_type (string) – the data type for the dictionary attribute, property of the request body. Available values are ‘BOOLEAN’, ‘DATE’, ‘FLOAT’, ‘INT’, ‘IP’, ‘IPV4’, ‘IPV6’, ‘IPV6INTERFACE’, ‘IPV6PREFIX’, ‘LONG’, ‘OCTET_STRING’, ‘STRING’, ‘UINT64’ and ‘UNIT32’.
description (string) – The description of the Dictionary attribute, property of the request body.
dictionary_name (basestring) – the name of the dictionary which the dictionary attribute belongs to, property of the request body.
direction_type (string) – the direction for the useage of the dictionary attribute, property of the request body. Available values are ‘BOTH’, ‘IN’, ‘NONE’ and ‘OUT’.
id (string) – Identifier for the dictionary attribute, property of the request body.
internal_name (string) – the internal name of the dictionary attribute, property of the request body.
name (string) – The dictionary attribute’s name, property of the request body.
dictionary_name – dictionaryName path parameter. the name of the dictionary the dictionary attribute belongs to.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(dictionary_name, allowed_values=None, data_type=None, description=None, direction_type=None, id=None, internal_name=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
-
get_network_access_dictionary_attribute_by_name
(dictionary_name, name, headers=None, **query_parameters)[source]¶ Get a Dictionary Attribute.
- Parameters
name (basestring) – name path parameter. the dictionary attribute name.
dictionary_name (basestring) – dictionaryName path parameter. the name of the dictionary the dictionary attribute belongs to.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_network_access_dictionary_attribute_by_name
(dictionary_name, name, allowed_values=None, data_type=None, description=None, direction_type=None, id=None, internal_name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Update a Dictionary Attribute.
- Parameters
allowed_values (list) – all of the allowed values for the dictionary attribute, property of the request body (list of objects).
data_type (string) – the data type for the dictionary attribute, property of the request body. Available values are ‘BOOLEAN’, ‘DATE’, ‘FLOAT’, ‘INT’, ‘IP’, ‘IPV4’, ‘IPV6’, ‘IPV6INTERFACE’, ‘IPV6PREFIX’, ‘LONG’, ‘OCTET_STRING’, ‘STRING’, ‘UINT64’ and ‘UNIT32’.
description (string) – The description of the Dictionary attribute, property of the request body.
dictionary_name (basestring) – the name of the dictionary which the dictionary attribute belongs to, property of the request body.
direction_type (string) – the direction for the useage of the dictionary attribute, property of the request body. Available values are ‘BOTH’, ‘IN’, ‘NONE’ and ‘OUT’.
id (string) – Identifier for the dictionary attribute, property of the request body.
internal_name (string) – the internal name of the dictionary attribute, property of the request body.
name (basestring) – The dictionary attribute’s name, property of the request body.
name – name path parameter. the dictionary attribute name.
dictionary_name – dictionaryName path parameter. the name of the dictionary the dictionary attribute belongs to.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_name
(dictionary_name, name, allowed_values=None, data_type=None, description=None, direction_type=None, id=None, internal_name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_network_access_dictionary_attribute_by_name
-
delete_network_access_dictionary_attribute_by_name
(dictionary_name, name, headers=None, **query_parameters)[source]¶ Delete a Dictionary Attribute.
- Parameters
name (basestring) – name path parameter. the dictionary attribute name.
dictionary_name (basestring) – dictionaryName path parameter. the name of the dictionary the dictionary attribute belongs to.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_name
(dictionary_name, name, headers=None, **query_parameters)[source]¶ Alias for delete_network_access_dictionary_attribute_by_name
-
network_access_dictionary_attributes_list¶
-
class
NetworkAccessDictionaryAttributesList
[source]¶ Identity Services Engine Network Access - Dictionary Attributes List API (version: 3.1.1).
Wraps the Identity Services Engine Network Access - Dictionary Attributes List API and exposes the API as native Python methods that return native Python objects.
-
get_network_access_dictionaries_authentication
(headers=None, **query_parameters)[source]¶ Network Access Returns list of dictionary attributes for authentication.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
Network Access Returns list of dictionary attributes for authorization.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_network_access_dictionaries_policy_set
(headers=None, **query_parameters)[source]¶ Network Access Returns list of dictionary attributes for policyset.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
network_access_identity_stores¶
-
class
NetworkAccessIdentityStores
[source]¶ Identity Services Engine Network Access - Identity Stores API (version: 3.1.1).
Wraps the Identity Services Engine Network Access - Identity Stores API and exposes the API as native Python methods that return native Python objects.
-
get_network_access_identity_stores
(headers=None, **query_parameters)[source]¶ Network Access Return list of identity stores for authentication policy definition. (Other CRUD APIs available throught ERS).
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(list): A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(headers=None, **query_parameters)[source]¶ Alias for get_network_access_identity_stores
-
network_access_network_conditions¶
-
class
NetworkAccessNetworkConditions
[source]¶ Identity Services Engine Network Access - Network Conditions API (version: 3.1.1).
Wraps the Identity Services Engine Network Access - Network Conditions API and exposes the API as native Python methods that return native Python objects.
-
get_network_access_network_conditions
(headers=None, **query_parameters)[source]¶ Network Access Returns a list of network conditions.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(headers=None, **query_parameters)[source]¶ Alias for get_network_access_network_conditions
-
create_network_access_network_condition
(condition_type=None, conditions=None, description=None, id=None, link=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Network Access Creates network condition.
- Parameters
condition_type (string) – This field determines the content of the conditions field, property of the request body. Available values are ‘DeviceCondition’, ‘DevicePortCondition’ and ‘EndstationCondition’.
conditions (list) – conditions, property of the request body (list of objects).
description (string) – description, property of the request body.
id (string) – id, property of the request body.
link (object) – link, property of the request body.
name (string) – Network Condition name, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(condition_type=None, conditions=None, description=None, id=None, link=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_network_access_network_condition
-
get_network_access_network_condition_by_id
(id, headers=None, **query_parameters)[source]¶ Network Access Returns a network condition.
- Parameters
id (basestring) – id path parameter. Condition id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_network_access_network_condition_by_id
(id, condition_type=None, conditions=None, description=None, link=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Network Access Update network condition.
- Parameters
condition_type (string) – This field determines the content of the conditions field, property of the request body. Available values are ‘DeviceCondition’, ‘DevicePortCondition’ and ‘EndstationCondition’.
conditions (list) – conditions, property of the request body (list of objects).
description (string) – description, property of the request body.
id (basestring) – id, property of the request body.
link (object) – link, property of the request body.
name (string) – Network Condition name, property of the request body.
id – id path parameter. Condition id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, condition_type=None, conditions=None, description=None, link=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
-
delete_network_access_network_condition_by_id
(id, headers=None, **query_parameters)[source]¶ Network Access Delete network condition.
- Parameters
id (basestring) – id path parameter. Condition id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
network_access_policy_set¶
-
class
NetworkAccessPolicySet
[source]¶ Identity Services Engine Network Access - Policy Set API (version: 3.1.1).
Wraps the Identity Services Engine Network Access - Policy Set API and exposes the API as native Python methods that return native Python objects.
-
get_network_access_policy_sets
(headers=None, **query_parameters)[source]¶ Get all network access policy sets.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(headers=None, **query_parameters)[source]¶ Alias for get_network_access_policy_sets
-
create_network_access_policy_set
(condition=None, default=None, description=None, hit_counts=None, id=None, is_proxy=None, link=None, name=None, rank=None, service_name=None, state=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Network Access Create a new policy set: Policy must include name , service identifier (either server sequence or allowed protocol) and a condition. Condition has hierarchical structure which define a set of condition for which policy could be match. Condition can be either reference to a stored Library condition, using model ConditionReference , or, dynamically built conditions which are not stored in the conditions Library, using models ConditionAttributes, ConditionAndBlock, ConditionOrBlock . .
- Parameters
condition (object) – condition, property of the request body.
default (boolean) – Flag which indicates if this policy set is the default one, property of the request body.
description (string) – The description for the policy set, property of the request body.
hit_counts (integer) – The amount of times the policy was matched, property of the request body.
id (string) – Identifier for the policy set, property of the request body.
is_proxy (boolean) – Flag which indicates if the policy set service is of type ‘Proxy Sequence’ or ‘Allowed Protocols’, property of the request body.
link (object) – link, property of the request body.
name (string) – Given name for the policy set, [Valid characters are alphanumerics, underscore, hyphen, space, period, parentheses], property of the request body.
rank (integer) – The rank(priority) in relation to other policy set. Lower rank is higher priority., property of the request body.
service_name (string) – Policy set service identifier Allowed Protocols,Server Sequence.., property of the request body.
state (string) – The state that the policy set is in. A disabled policy set cannot be matched., property of the request body. Available values are ‘disabled’, ‘enabled’ and ‘monitor’.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(condition=None, default=None, description=None, hit_counts=None, id=None, is_proxy=None, link=None, name=None, rank=None, service_name=None, state=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_network_access_policy_set
-
reset_hit_counts_network_access_policy_sets
(headers=None, **query_parameters)[source]¶ Network Access Reset HitCount for PolicySets.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_network_access_policy_set_by_id
(id, headers=None, **query_parameters)[source]¶ Network Access Get policy set attributes.
- Parameters
id (basestring) – id path parameter. Policy id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_network_access_policy_set_by_id
-
update_network_access_policy_set_by_id
(id, condition=None, default=None, description=None, hit_counts=None, is_proxy=None, link=None, name=None, rank=None, service_name=None, state=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Network Access Update a policy set.
- Parameters
condition (object) – condition, property of the request body.
default (boolean) – Flag which indicates if this policy set is the default one, property of the request body.
description (string) – The description for the policy set, property of the request body.
hit_counts (integer) – The amount of times the policy was matched, property of the request body.
id (basestring) – Identifier for the policy set, property of the request body.
is_proxy (boolean) – Flag which indicates if the policy set service is of type ‘Proxy Sequence’ or ‘Allowed Protocols’, property of the request body.
link (object) – link, property of the request body.
name (string) – Given name for the policy set, [Valid characters are alphanumerics, underscore, hyphen, space, period, parentheses], property of the request body.
rank (integer) – The rank(priority) in relation to other policy set. Lower rank is higher priority., property of the request body.
service_name (string) – Policy set service identifier Allowed Protocols,Server Sequence.., property of the request body.
state (string) – The state that the policy set is in. A disabled policy set cannot be matched., property of the request body. Available values are ‘disabled’, ‘enabled’ and ‘monitor’.
id – id path parameter. Policy id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, condition=None, default=None, description=None, hit_counts=None, is_proxy=None, link=None, name=None, rank=None, service_name=None, state=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_network_access_policy_set_by_id
-
delete_network_access_policy_set_by_id
(id, headers=None, **query_parameters)[source]¶ Network Access Delete a policy set.
- Parameters
id (basestring) – id path parameter. Policy id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_network_access_policy_set_by_id
-
network_access_profiles¶
-
class
NetworkAccessProfiles
[source]¶ Identity Services Engine Network Access - Profiles API (version: 3.1.1).
Wraps the Identity Services Engine Network Access - Profiles API and exposes the API as native Python methods that return native Python objects.
-
get_network_access_profiles
(headers=None, **query_parameters)[source]¶ Network Access Returns list of authorization profiles. (Other CRUD APIs available throught ERS).
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(list): A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(headers=None, **query_parameters)[source]¶ Alias for get_network_access_profiles
-
network_access_security_groups¶
-
class
NetworkAccessSecurityGroups
[source]¶ Identity Services Engine Network Access - Security Groups API (version: 3.1.1).
Wraps the Identity Services Engine Network Access - Security Groups API and exposes the API as native Python methods that return native Python objects.
-
get_network_access_security_groups
(headers=None, **query_parameters)[source]¶ Network Access Return list of available security groups for authorization policy definition. (Other CRUD APIs available throught ERS).
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(list): A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(headers=None, **query_parameters)[source]¶ Alias for get_network_access_security_groups
-
network_access_service_names¶
-
class
NetworkAccessServiceNames
[source]¶ Identity Services Engine Network Access - Service Names API (version: 3.1.1).
Wraps the Identity Services Engine Network Access - Service Names API and exposes the API as native Python methods that return native Python objects.
-
get_network_access_service_names
(headers=None, **query_parameters)[source]¶ Returns list of Allowed Protocols and Server Sequences for Network Access Policy Set results. ‘isLocalAuthorization’ property is available only for Network Access Policy Set results of type Server Sequence. (Other CRUD APIs available throught ERS).
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(list): A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(headers=None, **query_parameters)[source]¶ Alias for get_network_access_service_names
-
network_access_time_date_conditions¶
-
class
NetworkAccessTimeDateConditions
[source]¶ Identity Services Engine Network Access - Time/Date Conditions API (version: 3.1.1).
Wraps the Identity Services Engine Network Access - Time/Date Conditions API and exposes the API as native Python methods that return native Python objects.
-
get_network_access_time_conditions
(headers=None, **query_parameters)[source]¶ Network Access Returns a list of time and date conditions.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(headers=None, **query_parameters)[source]¶ Alias for get_network_access_time_conditions
-
create_network_access_time_condition
(attribute_name=None, attribute_value=None, children=None, condition_type=None, dates_range=None, dates_range_exception=None, description=None, dictionary_name=None, dictionary_value=None, hours_range=None, hours_range_exception=None, id=None, is_negate=None, link=None, name=None, operator=None, week_days=None, week_days_exception=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Network Access Creates time/date condition.
- Parameters
attribute_name (string) – Dictionary attribute name, property of the request body.
attribute_value (string) – Attribute value for condition Value type is specified in dictionary object if multiple values allowed is specified in dictionary object, property of the request body.
children (list) – In case type is andBlock or orBlock addtional conditions will be aggregated under this logical (OR/AND) condition, property of the request body (list of objects).
condition_type (string) – Inidicates whether the record is the condition itself(data) or a logical(or,and) aggregation Data type enum(reference,single) indicates than “conditonId” OR “ConditionAttrs” fields should contain condition data but not both Logical aggreation(and,or) enum indicates that additional conditions are present under the children field, property of the request body. Available values are ‘ConditionAndBlock’, ‘ConditionAttributes’, ‘ConditionOrBlock’, ‘ConditionReference’, ‘LibraryConditionAndBlock’, ‘LibraryConditionAttributes’, ‘LibraryConditionOrBlock’ and ‘TimeAndDateCondition’.
dates_range (object) – Defines for which date/s TimeAndDate condition will be matched Options are Date range, for specific date, the same date should be used for start/end date Default no specific dates In order to reset the dates to have no specific dates Date format yyyy- mm-dd (MM = month, dd = day, yyyy = year), property of the request body.
dates_range_exception (object) – Defines for which date/s TimeAndDate condition will be matched Options are Date range, for specific date, the same date should be used for start/end date Default no specific dates In order to reset the dates to have no specific dates Date format yyyy- mm-dd (MM = month, dd = day, yyyy = year), property of the request body.
description (string) – Condition description, property of the request body.
dictionary_name (string) – Dictionary name, property of the request body.
dictionary_value (string) – Dictionary value, property of the request body.
hours_range (object) – Defines for which hours a TimeAndDate condition will be matched Time format hh:mm ( h = hour , mm = minutes ) Default All Day , property of the request body.
hours_range_exception (object) – Defines for which hours a TimeAndDate condition will be matched Time format hh:mm ( h = hour , mm = minutes ) Default All Day , property of the request body.
id (string) – id, property of the request body.
is_negate (boolean) – Indicates whereas this condition is in negate mode, property of the request body.
link (object) – link, property of the request body.
name (string) – Condition name, property of the request body.
operator (string) – Equality operator, property of the request body. Available values are ‘contains’, ‘endsWith’, ‘equals’, ‘greaterOrEquals’, ‘greaterThan’, ‘in’, ‘ipEquals’, ‘ipGreaterThan’, ‘ipLessThan’, ‘ipNotEquals’, ‘lessOrEquals’, ‘lessThan’, ‘matches’, ‘notContains’, ‘notEndsWith’, ‘notEquals’, ‘notIn’, ‘notStartsWith’ and ‘startsWith’.
week_days (list) – Defines for which days this condition will be matched Days format Arrays of WeekDay enums Default List of All week days, property of the request body (list of strings. Available values are ‘Friday’, ‘Monday’, ‘Saturday’, ‘Sunday’, ‘Thursday’, ‘Tuesday’ and ‘Wednesday’).
week_days_exception (list) – Defines for which days this condition will NOT be matched Days format Arrays of WeekDay enums Default Not enabled, property of the request body (list of strings. Available values are ‘Friday’, ‘Monday’, ‘Saturday’, ‘Sunday’, ‘Thursday’, ‘Tuesday’ and ‘Wednesday’).
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(attribute_name=None, attribute_value=None, children=None, condition_type=None, dates_range=None, dates_range_exception=None, description=None, dictionary_name=None, dictionary_value=None, hours_range=None, hours_range_exception=None, id=None, is_negate=None, link=None, name=None, operator=None, week_days=None, week_days_exception=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_network_access_time_condition
-
get_network_access_time_condition_by_id
(id, headers=None, **query_parameters)[source]¶ Network Access returns a network condition.
- Parameters
id (basestring) – id path parameter. Condition id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_network_access_time_condition_by_id
-
update_network_access_time_condition_by_id
(id, attribute_name=None, attribute_value=None, children=None, condition_type=None, dates_range=None, dates_range_exception=None, description=None, dictionary_name=None, dictionary_value=None, hours_range=None, hours_range_exception=None, is_negate=None, link=None, name=None, operator=None, week_days=None, week_days_exception=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Network Access Update network condition.
- Parameters
attribute_name (string) – Dictionary attribute name, property of the request body.
attribute_value (string) – Attribute value for condition Value type is specified in dictionary object if multiple values allowed is specified in dictionary object, property of the request body.
children (list) – In case type is andBlock or orBlock addtional conditions will be aggregated under this logical (OR/AND) condition, property of the request body (list of objects).
condition_type (string) – Inidicates whether the record is the condition itself(data) or a logical(or,and) aggregation Data type enum(reference,single) indicates than “conditonId” OR “ConditionAttrs” fields should contain condition data but not both Logical aggreation(and,or) enum indicates that additional conditions are present under the children field, property of the request body. Available values are ‘ConditionAndBlock’, ‘ConditionAttributes’, ‘ConditionOrBlock’, ‘ConditionReference’, ‘LibraryConditionAndBlock’, ‘LibraryConditionAttributes’, ‘LibraryConditionOrBlock’ and ‘TimeAndDateCondition’.
dates_range (object) – Defines for which date/s TimeAndDate condition will be matched Options are Date range, for specific date, the same date should be used for start/end date Default no specific dates In order to reset the dates to have no specific dates Date format yyyy- mm-dd (MM = month, dd = day, yyyy = year), property of the request body.
dates_range_exception (object) – Defines for which date/s TimeAndDate condition will be matched Options are Date range, for specific date, the same date should be used for start/end date Default no specific dates In order to reset the dates to have no specific dates Date format yyyy- mm-dd (MM = month, dd = day, yyyy = year), property of the request body.
description (string) – Condition description, property of the request body.
dictionary_name (string) – Dictionary name, property of the request body.
dictionary_value (string) – Dictionary value, property of the request body.
hours_range (object) – Defines for which hours a TimeAndDate condition will be matched Time format hh:mm ( h = hour , mm = minutes ) Default All Day , property of the request body.
hours_range_exception (object) – Defines for which hours a TimeAndDate condition will be matched Time format hh:mm ( h = hour , mm = minutes ) Default All Day , property of the request body.
id (basestring) – id, property of the request body.
is_negate (boolean) – Indicates whereas this condition is in negate mode, property of the request body.
link (object) – link, property of the request body.
name (string) – Condition name, property of the request body.
operator (string) – Equality operator, property of the request body. Available values are ‘contains’, ‘endsWith’, ‘equals’, ‘greaterOrEquals’, ‘greaterThan’, ‘in’, ‘ipEquals’, ‘ipGreaterThan’, ‘ipLessThan’, ‘ipNotEquals’, ‘lessOrEquals’, ‘lessThan’, ‘matches’, ‘notContains’, ‘notEndsWith’, ‘notEquals’, ‘notIn’, ‘notStartsWith’ and ‘startsWith’.
week_days (list) – Defines for which days this condition will be matched Days format Arrays of WeekDay enums Default List of All week days, property of the request body (list of strings. Available values are ‘Friday’, ‘Monday’, ‘Saturday’, ‘Sunday’, ‘Thursday’, ‘Tuesday’ and ‘Wednesday’).
week_days_exception (list) – Defines for which days this condition will NOT be matched Days format Arrays of WeekDay enums Default Not enabled, property of the request body (list of strings. Available values are ‘Friday’, ‘Monday’, ‘Saturday’, ‘Sunday’, ‘Thursday’, ‘Tuesday’ and ‘Wednesday’).
id – id path parameter. Condition id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, attribute_name=None, attribute_value=None, children=None, condition_type=None, dates_range=None, dates_range_exception=None, description=None, dictionary_name=None, dictionary_value=None, hours_range=None, hours_range_exception=None, is_negate=None, link=None, name=None, operator=None, week_days=None, week_days_exception=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
-
delete_network_access_time_condition_by_id
(id, headers=None, **query_parameters)[source]¶ Network Access Delete Time/Date condition.
- Parameters
id (basestring) – id path parameter. Condition id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
network_device¶
-
class
NetworkDevice
[source]¶ Identity Services Engine NetworkDevice API (version: 3.1.1).
Wraps the Identity Services Engine NetworkDevice API and exposes the API as native Python methods that return native Python objects.
Network Device API allows the client to add, delete, update, and search network devices. Please note that each API description shows whether the API is supported in bulk operation. The bulk section is showing only ‘create’ bulk operation however, all other operation which are bulk supported can be used in same way.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
Revision Modification
Revision Modification
Attribute
Description
0
1.0
1.2
Initial Cisco ISE Version
1
1.1
2.0
Cisco ISE 2.0 model changes for TACACS+ and 3rd-Party support
tacacsSettings:sharedSecret
Added Attribute ‘sharedSecret’ for Tacacs+ support
tacacsSettings:connectModeOptions
Added Attribute ‘connectModeOptions’ for Tacacs+ support
profileName
Added Attribute ‘profileName’ for 3rd-Party support support
coaPort
Added Attribute ‘coaPort’ for 3rd-Party support support
2
1.2
2.4
Cisco ISE 2.4 model changes for Multi shared secret and DTLS Requierd support
authenticationsettings:enableMultiSecret
Added Attribute ‘enableMultiSecret’ for mulitple shared secret
authenticationsettings:secondRadiusSharedSecret
Added Attribute ‘secondRadiusSharedSecret’ for mulitple shared secret
authenticationsettings:dtlsRequired
Added Attribute ‘dtlsRequired’ for dtls settings
Resource Definition
Attribute
Type
Required
Description
Default Values
Example Values
name
String
Yes
Resource Name
ISE_EST_Local_Host
id
String
No
Resource UUID, mandatory for update
79aac430-7cc8-11eb-ad58-005056926583
description
String
No
example nd
authenticationSettings
List
Yes
enableKeyWrap
Boolean
Yes
false
enabled
Boolean
Yes
false
keyEncryptionKey
String
Yes
1234567890123456
keyInputFormat
Enum
Yes
Allowed values: ASCII, HEXADECIMAL
ASCII
messageAuthenticatorCodeKey
String
No
12345678901234567890
networkProtocol
Enum
No
Allowed values: RADIUS, TACACS_PLUS
RADIUS
radiusSharedSecret
String
No
VHEGKOCCUHYB
enableMultiSecret
Boolean
No
false
secondRadiusSharedSecret
String
No
dtlsRequired
Boolean
No
This value enforces use of dtls
false
coaPort
Integer
Yes
Since 2.0 (for 3rd party)
0
dtlsDnsName
String
No
This value is used to verify the client identity contained in the X.509 RADIUS/DTLS client certificate
ISE213.il.com
NetworkDeviceIPList
List
Yes
List of IP Subnets for this node
ipaddress
String
Yes
It can be either single IP address or IP range address
127.0.0.1
getIpaddressExclude
String
Yes
It can be either single IP address or IP range address
mask
Integer
Yes
32
NetworkDeviceGroupList
List
No
List of Network Device Group names for this node
[ “Location#All Locations”, “Device Type#All Device Types” ]
modelName
String
No
softwareVersion
String
No
profileName
String
Yes
Since 2.0 (for 3rd party)
true
Cisco
snmpsettings
List
Yes
linkTrapQuery
Boolean
Yes
SNMP link Trap Query
true
macTrapQuery
Boolean
Yes
SNMP MAC Trap Query
true
originatingPolicyServicesNode
String
Yes
Originating Policy Services Node
Auto
pollingInterval
Integer
Yes
SNMP Polling Interval in seconds (Valid Range 600 to 86400)
3600
roCommunity
String
No
SNMP RO Community
aaa
version
Enum
No
Allowed values: ONE, TWO_C, THREE
ONE
tacacsSettings
List
Yes
Since 2.0 (for Tacacs+)
connectModeOptions
Enum
No
Allowed values: OFF, ON_LEGACY, ON_DRAFT_COMPLIANT
ON_LEGACY
sharedSecret
String
Yes
Since 2.0
aaa
trustsecsettings
List
Yes
deviceAuthenticationSettings
List
Yes
sgaDeviceId
String
No
networkDevice1
sgaDevicePassword
String
No
aaa
deviceConfigurationDeployment
List
Yes
enableModePassword
String
No
aaa
execModePassword
String
No
aaa
execModeUsername
String
No
aaa
includeWhenDeployingSGTUpdates
Boolean
No
false
sgaNotificationAndUpdates
List
Yes
downlaodEnvironmentDataEveryXSeconds
Integer
No
86400
downlaodPeerAuthorizationPolicyEveryXSeconds
Integer
No
86400
downloadSGACLListsEveryXSeconds
Integer
No
86400
otherSGADevicesToTrustThisDevice
Boolean
No
false
reAuthenticationEveryXSeconds
Integer
No
86400
sendConfigurationToDevice
Boolean
No
false
sendConfigurationToDeviceUsing
Enum
No
Allowed values: ENABLE_USING_COA, ENABLE_USING_CLI, DISABLE_ALL
ENABLE_USING_COA
-
get_network_device_by_name
(name, headers=None, **query_parameters)[source]¶ This API allows the client to get a network device by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_name
(name, headers=None, **query_parameters)[source]¶ Alias for get_network_device_by_name
-
update_network_device_by_name
(name, authentication_settings=None, coa_port=None, description=None, dtls_dns_name=None, id=None, model_name=None, network_device_group_list=None, network_device_iplist=None, profile_name=None, snmpsettings=None, software_version=None, tacacs_settings=None, trustsecsettings=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update a network device by name.
- Parameters
network_device_group_list (list) – List of Network Device Group names for this node, property of the request body (list of strings).
network_device_iplist (list) – List of IP Subnets for this node, property of the request body (list of objects).
authentication_settings (object) – authenticationSettings, property of the request body.
coa_port (integer) – coaPort, property of the request body.
description (string) – description, property of the request body.
dtls_dns_name (string) – This value is used to verify the client identity contained in the X.509 RADIUS/DTLS client certificate, property of the request body.
id (string) – id, property of the request body.
model_name (string) – modelName, property of the request body.
name (basestring) – name, property of the request body.
profile_name (string) – profileName, property of the request body.
snmpsettings (object) – snmpsettings, property of the request body.
software_version (string) – softwareVersion, property of the request body.
tacacs_settings (object) – tacacsSettings, property of the request body.
trustsecsettings (object) – trustsecsettings, property of the request body.
name – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_name
(name, authentication_settings=None, coa_port=None, description=None, dtls_dns_name=None, id=None, model_name=None, network_device_group_list=None, network_device_iplist=None, profile_name=None, snmpsettings=None, software_version=None, tacacs_settings=None, trustsecsettings=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_network_device_by_name
-
delete_network_device_by_name
(name, headers=None, **query_parameters)[source]¶ This API deletes a network device by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_name
(name, headers=None, **query_parameters)[source]¶ Alias for delete_network_device_by_name
-
get_network_device_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get a network device by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_network_device_by_id
-
update_network_device_by_id
(id, authentication_settings=None, coa_port=None, description=None, dtls_dns_name=None, model_name=None, name=None, network_device_group_list=None, network_device_iplist=None, profile_name=None, snmpsettings=None, software_version=None, tacacs_settings=None, trustsecsettings=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update a network device by ID.
- Parameters
network_device_group_list (list) – List of Network Device Group names for this node, property of the request body (list of strings).
network_device_iplist (list) – List of IP Subnets for this node, property of the request body (list of objects).
authentication_settings (object) – authenticationSettings, property of the request body.
coa_port (integer) – coaPort, property of the request body.
description (string) – description, property of the request body.
dtls_dns_name (string) – This value is used to verify the client identity contained in the X.509 RADIUS/DTLS client certificate, property of the request body.
id (basestring) – id, property of the request body.
model_name (string) – modelName, property of the request body.
name (string) – name, property of the request body.
profile_name (string) – profileName, property of the request body.
snmpsettings (object) – snmpsettings, property of the request body.
software_version (string) – softwareVersion, property of the request body.
tacacs_settings (object) – tacacsSettings, property of the request body.
trustsecsettings (object) – trustsecsettings, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, authentication_settings=None, coa_port=None, description=None, dtls_dns_name=None, model_name=None, name=None, network_device_group_list=None, network_device_iplist=None, profile_name=None, snmpsettings=None, software_version=None, tacacs_settings=None, trustsecsettings=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_network_device_by_id
-
delete_network_device_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes a network device by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_network_device_by_id
-
get_network_device
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the network devices. Filter: [ipaddress, name, description, location, type] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_network_device
-
get_network_device_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the network devices. Filter: [ipaddress, name, description, location, type] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_network_device_generator
-
create_network_device
(authentication_settings=None, coa_port=None, description=None, dtls_dns_name=None, model_name=None, name=None, network_device_group_list=None, network_device_iplist=None, profile_name=None, snmpsettings=None, software_version=None, tacacs_settings=None, trustsecsettings=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates a network device.
- Parameters
network_device_group_list (list) – List of Network Device Group names for this node, property of the request body (list of strings).
network_device_iplist (list) – List of IP Subnets for this node, property of the request body (list of objects).
authentication_settings (object) – authenticationSettings, property of the request body.
coa_port (integer) – coaPort, property of the request body.
description (string) – description, property of the request body.
dtls_dns_name (string) – This value is used to verify the client identity contained in the X.509 RADIUS/DTLS client certificate, property of the request body.
model_name (string) – modelName, property of the request body.
name (string) – name, property of the request body.
profile_name (string) – profileName, property of the request body.
snmpsettings (object) – snmpsettings, property of the request body.
software_version (string) – softwareVersion, property of the request body.
tacacs_settings (object) – tacacsSettings, property of the request body.
trustsecsettings (object) – trustsecsettings, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(authentication_settings=None, coa_port=None, description=None, dtls_dns_name=None, model_name=None, name=None, network_device_group_list=None, network_device_iplist=None, profile_name=None, snmpsettings=None, software_version=None, tacacs_settings=None, trustsecsettings=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_network_device
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the network device.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
bulk_request_for_network_device
(operation_type=None, resource_media_type=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to submit the bulk request.
- Parameters
operation_type (string) – operationType, property of the request body.
resource_media_type (string) – resourceMediaType, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
bulk_request
(operation_type=None, resource_media_type=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for bulk_request_for_network_device
-
monitor_bulk_status_network_device
(bulkid, headers=None, **query_parameters)[source]¶ This API allows the client to monitor the bulk request.
- Parameters
bulkid (basestring) – bulkid path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
monitor_bulk_status
(bulkid, headers=None, **query_parameters)[source]¶ Alias for monitor_bulk_status_network_device
network_device_group¶
-
class
NetworkDeviceGroup
[source]¶ Identity Services Engine NetworkDeviceGroup API (version: 3.1.1).
Wraps the Identity Services Engine NetworkDeviceGroup API and exposes the API as native Python methods that return native Python objects.
Network Device Group API allows the client to search network device groups.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
1.3
Initial Cisco ISE Version
1
1.1
2.4
Added GetByName operation
Resource Definition
Attribute
Type
Required
Description
Example Values
name
String
Yes
Resource Name
Device Type#All Device Types
id
String
No
Resource UUID, mandatory for update
70c79c30-8bff-11e6-996c-525400b48521
description
String
No
All Device Types
othername
String
No
Device Type
-
get_network_device_group_by_name
(name, headers=None, **query_parameters)[source]¶ This API allows the client to get a network device group by name.
- Parameters
name (basestring) – name path parameter. colon is used as a separator instead of (#) in the NDG name. For example, if the name is a#b#c it should appear in the request URL as a:b:c.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_name
(name, headers=None, **query_parameters)[source]¶ Alias for get_network_device_group_by_name
-
get_network_device_group_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get a network device group by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_network_device_group_by_id
-
update_network_device_group_by_id
(id, description=None, name=None, othername=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update a network device group.
- Parameters
description (string) – description, property of the request body.
id (basestring) – id, property of the request body.
name (string) – name, property of the request body.
othername (string) – othername, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, description=None, name=None, othername=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_network_device_group_by_id
-
delete_network_device_group_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes a network device group.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_network_device_group_by_id
-
get_network_device_group
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the network device groups. Filter: [name, description, type] To search guest users by using toDate column,follow the format: DD- MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_network_device_group
-
get_network_device_group_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the network device groups. Filter: [name, description, type] To search guest users by using toDate column,follow the format: DD- MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_network_device_group_generator
-
create_network_device_group
(description=None, name=None, othername=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates a network device group.
- Parameters
description (string) – description, property of the request body.
name (string) – name, property of the request body.
othername (string) – othername, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(description=None, name=None, othername=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_network_device_group
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the network device group.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
node_deployment¶
-
class
NodeDeployment
[source]¶ Identity Services Engine Node Deployment API (version: 3.1.1).
Wraps the Identity Services Engine Node Deployment API and exposes the API as native Python methods that return native Python objects.
-
get_nodes
(filter=None, filter_type=None, headers=None, **query_parameters)[source]¶ The API lists all the nodes that are deployed in the cluster. Returns basic information about each of the deployed nodes in the cluster like hostname, status, roles, and services. Supports filtering on FQDN, hostname, IP address, roles, services and node status. .
- Parameters
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering is available through the filter query string parameter. The structure of a filter is a triplet of field operator and value, separated by dots. More than one filter can be sent. The logical operator common to all filter criteria is AND by default, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. OPERATOR DESCRIPTION EQ Equals NEQ Not Equals STARTSW Starts With NSTARTSW Not Starts With ENDSW Ends With NENDSW Not Ends With CONTAINS Contains NCONTAINS Not Contains .
filter_type (basestring) – filterType query parameter. The logical operator common to all filter criteria is AND by default, and can be changed by using this parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
register_node
(allow_cert_import=None, fqdn=None, password=None, roles=None, services=None, user_name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API registers a Cisco ISE node to form a multi-node deployment. Approximate execution time 300 seconds. .
- Parameters
allow_cert_import (boolean) – Consent to import the self- signed certificate of the registering node. , property of the request body.
fqdn (string) – fqdn, property of the request body.
password (string) – password, property of the request body.
roles (list) – Roles can be empty or have many values for a node. , property of the request body (list of strings. Available values are ‘PrimaryAdmin’, ‘PrimaryDedicatedMonitoring’, ‘PrimaryMonitoring’, ‘SecondaryAdmin’, ‘SecondaryDedicatedMonitoring’, ‘SecondaryMonitoring’ and ‘Standalone’).
services (list) – Services can be empty or have many values for a node. , property of the request body (list of strings. Available values are ‘DeviceAdmin’, ‘PassiveIdentity’, ‘Profiler’, ‘SXP’, ‘Session’, ‘TC-NAC’, ‘pxGrid’ and ‘pxGridCloud’).
user_name (string) – userName, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_node_details
(hostname, headers=None, **query_parameters)[source]¶ This API retrieves detailed information of the deployed node. .
- Parameters
hostname (basestring) – hostname path parameter. Hostname of the deployed node.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(hostname, headers=None, **query_parameters)[source]¶ Alias for get_node_details
-
update_node
(hostname, roles=None, services=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API updates the configuration of the Cisco ISE node with the configuration provided. Approximate execution time 300 seconds. .
- Parameters
roles (list) – Roles can be empty or have many values for a node. , property of the request body (list of strings. Available values are ‘PrimaryAdmin’, ‘PrimaryDedicatedMonitoring’, ‘PrimaryMonitoring’, ‘SecondaryAdmin’, ‘SecondaryDedicatedMonitoring’, ‘SecondaryMonitoring’ and ‘Standalone’).
services (list) – Services can be empty or have many values for a node. , property of the request body (list of strings. Available values are ‘DeviceAdmin’, ‘PassiveIdentity’, ‘Profiler’, ‘SXP’, ‘Session’, ‘TC-NAC’, ‘pxGrid’ and ‘pxGridCloud’).
hostname (basestring) – hostname path parameter. Hostname of the deployed node.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_node
(hostname, headers=None, **query_parameters)[source]¶ The deregistered node becomes a standalone Cisco ISE node. It retains the last configuration that it received from the primary PAN and assumes the default roles and services of a standalone node. Approximate execution time 300 seconds. .
- Parameters
hostname (basestring) – hostname path parameter. The hostname of the node in the deployment to be deregistered.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
make_primary
(headers=None, **query_parameters)[source]¶ This API promotes the standalone node on which the API is invoked to the primary Policy Administration node (PAN). .
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
promote_node
(headers=None, **query_parameters)[source]¶ Execute this API in the secondary PAN in the cluster to promote the node to primary PAN. Ensure that the API Gateway setting is enabled in the secondary PAN. Approximate execution time 300 seconds. .
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
make_standalone
(headers=None, **query_parameters)[source]¶ This API changes the primary PAN in a single node cluster on which the API is invoked, to a standalone node. .
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
sync_node
(hostname, headers=None, **query_parameters)[source]¶ Performing a manual synchronization involves a reload of the target node, but not the primary PAN. Approximate execution time 300 seconds.
- Parameters
hostname (basestring) – hostname path parameter. Hostname of the node.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
node_group¶
-
class
NodeGroup
[source]¶ Identity Services Engine Node Group API (version: 3.1.1).
Wraps the Identity Services Engine Node Group API and exposes the API as native Python methods that return native Python objects.
-
get_node_groups
(headers=None, **query_parameters)[source]¶ This API retrieves the details of all the node groups in the cluster. Each node group retrieved consists of name, description and MAR cache details like query-attempts, query-timeout, replication-attempts, replication- timeout. .
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create_node_group
(description=None, mar_cache=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates a node group in the cluster. A node group is a group of PSNs, where the PSNs maintain a heartbeat with each other. It is used primarily to terminate or transfer posture-pending sessions when a PSN in a local node group fails. Node group members can communicate over TCP/7800. The following parameters are used in the request body of the API: PARAMETER DESCRIPTION EXAMPLE name * required Name of the node group( valid-range: 1-100 characters) {“name”: “site1”} description Description of the node group ( valid-range: 0-256 characters) {“name”: “site2”, “description”: “sample”} query-attempts The number of times Cisco ISE attempts to perform the cache entry query. ( valid-range: 0 5, default-value: 1) {“name”: “site3”,”marCache”: {“query-attempts”: 1}} query-timeout The time, in seconds, after which a cache entry query times out. ( valid-range: 1 10, default-value: 2) second(s) {“name”: “site4”,”marCache”: {“query-timeout”: 2}} replication-attempts The number of times Cisco ISE attempts to perform MAR cache entry replication. ( valid-range: 0 5, default-value: 2) {“name”: “site5”,”marCache”: {“replication-attempts”: 2}} replication-timeout The time, in seconds, after which the cache entry replication times out. ( valid-range: 1 10, default-value: 5) second(s) {“name”: “site6”,”marCache”: {“replication-timeout”: 5}} NOTE 1: : Node group name and description cannot contain any of the following characters: ! % ^ : ; , . ~ @ # & [ { ( | ) } ] ` > < / ” + = ? NOTE 2: : Parameter marCache stands for Machine Access Restriction (MAR) cache that provides an additional means of controlling authorization for Active Directory- authentication users. We can enable the marCache for a nodegroup by providing key “marCache” in json request. Additionally we may also provide any combination of parameters query-attempts, query-timeout, replication- attempts, replication-timeout in marCache object. If no value is specified for a particular parameter its default value will be recorded.If no marCache object is given, marCache will be considered as disabled. .
- Parameters
description (string) – description, property of the request body.
mar_cache (object) – marCache, property of the request body.
name (string) – name, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_node_group
(node_group_name, headers=None, **query_parameters)[source]¶ This API retrieves the details of a node group in the cluster using a node group name.
- Parameters
node_group_name (basestring) – nodeGroupName path parameter. Name of the existing node group.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_node_group
(node_group_name, description=None, mar_cache=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Purpose of this API is to update an existing node group. The following parameters are used in the request body of the API: PARAMETER DESCRIPTION EXAMPLE name * required Name of the node group existing in ISE( valid-range: 1-100 characters) NOTE : name of an existing node group cannot be modified. “name” parameter should be identical to the node group name(nodeGroupName) provided in the path {“name”: “site1”} description Description of the node group ( valid-range: 0-256 characters) {“name”: “site2”, “description”: “sample”} query-attempts The number of times Cisco ISE attempts to perform the cache entry query. ( valid-range: 0 5, default-value: 1) {“name”: “site3”,”marCache”: {“query-attempts”: 1}} query-timeout The time, in seconds, after which a cache entry query times out. ( valid-range: 1 10, default-value: 2) second(s) {“name”: “site4”,”marCache”: {“query-timeout”: 2}} replication-attempts The number of times Cisco ISE attempts to perform MAR cache entry replication. ( valid-range: 0 5, default-value: 2) {“name”: “site5”,”marCache”: {“replication-attempts”: 2}} replication-timeout The time, in seconds, after which the cache entry replication times out. ( valid-range: 1 10, default-value: 5) second(s) {“name”: “site6”,”marCache”: {“replication-timeout”: 5}} NOTE 1: Node group name and description cannot contain any of the following characters: ! % ^ : ; , . ~ @ # & [ { ( | ) } ] ` > < / ” + = ? NOTE 2: Parameter marCache stands for Machine Access Restriction (MAR) cache that provides an additional means of controlling authorization for Active Directory-authentication users. We can enable the marCache for a nodegroup by providing key “marCache” in json request. Additionally we may also provide any combination of parameters query-attempts, query-timeout, replication-attempts, replication-timeout in marCache object. If no value is specified for a particular parameter its default value will be recorded. If no marCache object is given, marCache will be disabled. .
- Parameters
description (string) – description, property of the request body.
mar_cache (object) – marCache, property of the request body.
name (string) – name, property of the request body.
node_group_name (basestring) – nodeGroupName path parameter. Name of the existing node group.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_node_group
(force_delete, node_group_name, headers=None, **query_parameters)[source]¶ Delete an existing node group in the cluster. Deleting the node group does not delete the nodes, but failover is no longer carried out among the nodes.
- Parameters
node_group_name (basestring) – nodeGroupName path parameter. Name of the existing node group.
force_delete (bool) – forceDelete query parameter. Force delete the group even if the node group contains one or more nodes.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
add_node
(node_group_name, hostname=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API adds a node to the node group in the cluster. When a node that belongs to a node group fails, another node in the same node group issues a Change of Authorization (CoA) for all the URL-redirected sessions on the failed node. The following parameters are used in the request body of the API: PARAMETER DESCRIPTION EXAMPLE hostname * required Name of the host name {“hostname”: “isenode”} .
- Parameters
hostname (string) – hostname, property of the request body.
node_group_name (basestring) – nodeGroupName path parameter. Name of the existing node group.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_nodes
(node_group_name, headers=None, **query_parameters)[source]¶ This API retrieves the list of nodes associated with a node group in the cluster with a given node group name.
- Parameters
node_group_name (basestring) – nodeGroupName path parameter. Name of the existing node group.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
remove_node
(node_group_name, hostname=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Purpose of this API is to remove a node from a node group in the cluster. Removing node from the node group does not delete the node, but failover is no longer carried out if the node is not part any node group. The following parameters are used in the request body of the API: PARAMETER DESCRIPTION EXAMPLE hostname * required Name of the host name {“hostname”: “isenode”} .
- Parameters
hostname (string) – hostname, property of the request body.
node_group_name (basestring) – nodeGroupName path parameter. Name of the existing node group.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
node_services¶
-
class
NodeServices
[source]¶ Identity Services Engine Node Services API (version: 3.1.1).
Wraps the Identity Services Engine Node Services API and exposes the API as native Python methods that return native Python objects.
-
get_interfaces
(hostname, headers=None, **query_parameters)[source]¶ This API retrieves the list of interfaces on a node in a cluster. .
- Parameters
hostname (basestring) – hostname path parameter. Hostname of the node.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_sxp_interface
(hostname, headers=None, **query_parameters)[source]¶ This API retrieves the SXP interface. .
- Parameters
hostname (basestring) – hostname path parameter. Hostname of the node.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
set_sxp_interface
(hostname, interface=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API configures the SXP interface. .
- Parameters
interface (string) – interface, property of the request body.
hostname (basestring) – hostname path parameter. Hostname of the node.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_profiler_probe_config
(hostname, headers=None, **query_parameters)[source]¶ This API retrieves the profiler probe configuration of a PSN. .
- Parameters
hostname (basestring) – hostname path parameter. Hostname of the node.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
set_profiler_probe_config
(hostname, active_directory=None, dhcp=None, dhcp_span=None, dns=None, http=None, netflow=None, nmap=None, pxgrid=None, radius=None, snmp_query=None, snmp_trap=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API updates the profiler probe configuration of a PSN. Set probe value as null to disable probe. Ex: Below payload will disable NMAP, PxGrid and SNMPTRAP probes { “activeDirectory”: { “daysBeforeRescan”: 1 }, “dhcp”: { “interfaces”: “[{“interface”:”GigabitEthernet 0”}]”, “port”: 0 }, “dhcpSpan”: { “interfaces”: “[{“interface”:”GigabitEthernet 0”}]” }, “dns”: { “timeout”: 2 }, “http”: { “interfaces”: “[{“interface”:”GigabitEthernet 0”}]” }, “netflow”: { “interfaces”: “[{“interface”:”GigabitEthernet 0”}]”, “port”: 0 }, “nmap”: null , “pxgrid”: null , “radius”: [], “snmpQuery”: { “eventTimeout”: 30, “retries”: 2, “timeout”: 1000 }, “snmpTrap”: null } .
- Parameters
active_directory (object) – The Active Directory probe queries the Active Directory for Windows information., property of the request body.
dhcp (object) – The DHCP probe listens for DHCP packets from IP helpers., property of the request body.
dhcp_span (object) – The DHCP SPAN probe collects DHCP packets., property of the request body.
dns (object) – The DNS probe performs a DNS lookup for the FQDN., property of the request body.
http (object) – The HTTP probe receives and parses HTTP packets., property of the request body.
netflow (object) – The NetFlow probe collects the NetFlow packets that are sent to it from routers., property of the request body.
nmap (list) – The NMAP probe scans endpoints for open ports and OS., property of the request body (list of objects).
pxgrid (list) – The pxGrid probe fetches attributes of MAC address or IP address as a subscriber from the pxGrid queue., property of the request body (list of objects).
radius (list) – The RADIUS probe collects RADIUS session attributes as well as CDP, LLDP, DHCP, HTTP, and MDM attributes from IOS Sensors., property of the request body (list of objects).
snmp_query (object) – The SNMP query probe collects details from network devices such as interface, CDP, LLDP, and ARP., property of the request body.
snmp_trap (object) – The SNMP trap probe receives linkup, linkdown, and MAC notification traps from network devices., property of the request body.
hostname (basestring) – hostname path parameter. Hostname of the node.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
node_details¶
-
class
NodeDetails
[source]¶ Identity Services Engine NodeDetails API (version: 3.1.1).
Wraps the Identity Services Engine NodeDetails API and exposes the API as native Python methods that return native Python objects.
Node Details API allows the client to get deployment node details, get all nodes and filter nodes based on NodeServiceTypes.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
Revision Modification
Revision Modification
Attribute
Description
0
1.0
2.2
Initial Cisco ISE Version
1
1.1
2.4
Support Node Service Types as part of Node Object
NodeServiceTypes
Added String Field NodeServiceTypes. String represents services configured on the Node
2
1.2
2.7
Support Node FQDN as part of Node Object
fqdn
Added String Field FQDN. String represents FQDN of the Node
3
1.3
3.0
Support SXP IP Address as part of Node Details
sxpIpAddress
Added String Field sxpIpAddress. String represents SXP IP Address of the Node
Resource Definition
Attribute
Type
Required
Description
Example Values
name
String
Yes
Resource Name
TestNode
id
String
No
Resource UUID, mandatory for update
ab6deded-fcc2-47ff-8577-0014737c8fcf
description
String
No
gateWay
String
No
10.0.10.11
displayName
String
No
TestNode
inDeployment
Boolean
No
false
ipAddresses
String
No
[ “10.0.0.1”, “10.0.0.2” ]
otherPapFqdn
String
No
OtherTestNode
ipAddress
String
No
10.0.0.3
sxpIpAddress
String
No
10.10.10.1
nodeServiceTypes
String
No
DEVICE ADMIN
fqdn
String
No
test.ers.cisco.com
primaryPapNode
Boolean
No
true
papNode
Boolean
No
true
pxGridNode
Boolean
No
true
-
get_node_detail_by_name
(name, headers=None, **query_parameters)[source]¶ This API allows the client to get node details by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_name
(name, headers=None, **query_parameters)[source]¶ Alias for get_node_detail_by_name
-
get_node_detail_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get node details by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_node_detail_by_id
-
get_node_details
(filter=None, filter_type=None, page=None, size=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the node details. Filter: [nodeservicetypes] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 .
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_node_details
-
get_node_details_generator
(filter=None, filter_type=None, page=None, size=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the node details. Filter: [nodeservicetypes] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 .
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_node_details_generator
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information realted to the node details.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
pan_ha¶
-
class
PanHa
[source]¶ Identity Services Engine PAN HA API (version: 3.1.1).
Wraps the Identity Services Engine PAN HA API and exposes the API as native Python methods that return native Python objects.
-
get_pan_ha_status
(headers=None, **query_parameters)[source]¶ In a high availability configuration, the primary PAN is in active state. The secondary PAN (backup PAN) is in standby state, which means that it receives all the configuration updates from the primary PAN, but is not active in the Cisco ISE cluster. You can configure Cisco ISE to automatically promote the secondary PAN when the primary PAN becomes unavailable.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_pan_ha
(failed_attempts=None, is_enabled=None, polling_interval=None, primary_health_check_node=None, secondary_health_check_node=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ To deploy the auto-failover feature, you must have at least three nodes, where two of the nodes assume the Administration persona, and one node acts as the health check node. A health check node is a non-administration node and can be a Policy Service, Monitoring, or pxGrid node, or any combination of these. If the PANs are in different data centers, you must have a health check node for each PAN. All the fields are mandatory to enable PanHA. Values of failedAttempts, pollingInterval, primaryHealthCheckNode, and secondaryHealthCheckNode are not considered when the isEnable value is “false” in the request body.
- Parameters
failed_attempts (integer) – Failover occurs if the primary PAN is down for the specified number of failure polls. Count (2 60). The default value is 5. , property of the request body.
is_enabled (boolean) – isEnabled, property of the request body.
polling_interval (integer) – Administration nodes are checked after each interval. Seconds (30 300) The default value is 120. , property of the request body.
primary_health_check_node (object) – primaryHealthCheckNode, property of the request body.
secondary_health_check_node (object) – secondaryHealthCheckNode, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
patching¶
-
class
Patching
[source]¶ Identity Services Engine Patching API (version: 3.1.1).
Wraps the Identity Services Engine Patching API and exposes the API as native Python methods that return native Python objects.
-
list_installed_hotpatches
(headers=None, **query_parameters)[source]¶ List all the installed hot patches in the system. .
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
install_hotpatch
(hotpatch_name=None, repository_name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Triggers hot patch installation on the Cisco ISE node. A task ID is returned which can be used to monitor the progress of the hot patch installation process. As hot patch installation triggers the Cisco ISE to restart, the task API becomes unavailable for a certain period of time. .
- Parameters
hotpatch_name (string) – hotpatchName, property of the request body.
repository_name (string) – repositoryName, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
rollback_hotpatch
(hotpatch_name=None, repository_name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Triggers hot patch rollback on the Cisco ISE node. A task ID is returned which can be used to monitor the progress of the hot patch rollback process. As hot patch rollback triggers the Cisco ISE to restart, the task API becomes unavailable for a certain period of time. .
- Parameters
hotpatch_name (string) – hotpatchName, property of the request body.
repository_name (string) – repositoryName, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
list_installed_patches
(headers=None, **query_parameters)[source]¶ List all the installed patches in the system, with the patch number for rollback. .
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
install_patch
(patch_name=None, repository_name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Triggers patch installation on the Cisco ISE node. A task ID is returned which can be used to monitor the progress of the patch installation process. As the patch installation triggers the Cisco ISE to restart, the task API becomes unavailable for a certain period of time. .
- Parameters
patch_name (string) – patchName, property of the request body.
repository_name (string) – repositoryName, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
rollback_patch
(patch_number=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Triggers patch rollback on the Cisco ISE node. A task ID is returned which can be used to monitor the progress of the patch rollback process. As the patch rollback triggers the Cisco ISE to restart, the task API becomes unavailable for a certain period of time. .
- Parameters
patch_number (integer) – patchNumber, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
portal_global_setting¶
-
class
PortalGlobalSetting
[source]¶ Identity Services Engine PortalGlobalSetting API (version: 3.1.1).
Wraps the Identity Services Engine PortalGlobalSetting API and exposes the API as native Python methods that return native Python objects.
The Portal Global Setting API allows the user to customize the text that is displayed in the Cisco ISE portals. This global setting controls whether HTML alone or both HTML and Javascript are permitted to be used in customized text.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.2
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Example Values
id
String
Yes
Resource UUID value
21013cb2-d030-4fb1-9ba2-35757634d770
customization
Enum
Yes
Allowed values: HTML, HTMLANDJAVASCRIPT
HTML
-
get_portal_global_setting_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get the portal global settings by id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_portal_global_setting_by_id
-
update_portal_global_setting_by_id
(id, customization=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update the portal global settings by id.
- Parameters
customization (string) – Allowed values: HTML, HTMLANDJAVASCRIPT, property of the request body.
id (basestring) – id, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, customization=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_portal_global_setting_by_id
-
get_portal_global_settings
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the portal global settings. Filter: [name] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_portal_global_settings
-
get_portal_global_settings_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the portal global settings. Filter: [name] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_portal_global_settings_generator
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the portal global setting .
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
portal_theme¶
-
class
PortalTheme
[source]¶ Identity Services Engine PortalTheme API (version: 3.1.1).
Wraps the Identity Services Engine PortalTheme API and exposes the API as native Python methods that return native Python objects.
Portal Theme API allows the client to add, delete, update and search Portal Theme among other operations which are available from all the portals.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.2
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Example Values
name
String
Yes
Resource Name
Default Blue theme
id
String
No
Resource UUID, mandatory for update
9eb421c0-8c01-11e6-996c-525400b48521
description
String
No
themeData
String
Yes
Portal Theme for all portals
Base 64 encoded string of CSS file
-
get_portal_theme_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get a portal theme by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_portal_theme_by_id
-
update_portal_theme_by_id
(id, description=None, name=None, theme_data=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update a portal theme by ID.
- Parameters
description (string) – description, property of the request body.
id (basestring) – id, property of the request body.
name (string) – name, property of the request body.
theme_data (string) – Portal Theme for all portals, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, description=None, name=None, theme_data=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_portal_theme_by_id
-
delete_portal_theme_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes a portal theme by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_portal_theme_by_id
-
get_portal_themes
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the portal themes. Filter: [name] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_portal_themes
-
get_portal_themes_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the portal themes. Filter: [name] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_portal_themes_generator
-
create_portal_theme
(description=None, name=None, theme_data=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates a portal theme.
- Parameters
description (string) – description, property of the request body.
name (string) – name, property of the request body.
theme_data (string) – Portal Theme for all portals, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(description=None, name=None, theme_data=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_portal_theme
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the portal theme.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
profiler¶
-
class
Profiler
[source]¶ Identity Services Engine Profiler API (version: 3.1.1).
Wraps the Identity Services Engine Profiler API and exposes the API as native Python methods that return native Python objects.
# Cisco ISE 3.0 pxGrid REST APIs
## License [Cisco Sample Code License](https://developer.cisco.com/site/license/cisco-sample-code-license/)
## Status These are the status icons for the requests so far. - ⌗ : must create resources to test - 🚧 : incomplete | untested - 🛑 : unsupported | bug
## Environment Variables This collection uses environment variables in scripts in the Tests tab to store data (id, name, portalId, etc.) between requests. This allows you to GET or POST then immediately GET {id} on a resource. Using No Environment will cause this convenience functionality to fail so be sure to choose one.
## Collection Variables This collection includes some default variables that you will want to update or override with environment variables for your ISE deployment. Specifically, you will want to set: - ise_pxg: the ISE PAN node name or IP address. Default: ise.securitydemo.net - rest_username: the username for ERS API access. Must be a member of SuperAdmin, ERSAdmin or ERSOperator groups. Default: admin which is the ISE SuperAdmin - rest_password: Default: C1sco12345
-
get_profiles
(headers=None, **query_parameters)[source]¶ 🚧 getProfiles.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
profiler_profile¶
-
class
ProfilerProfile
[source]¶ Identity Services Engine ProfilerProfile API (version: 3.1.1).
Wraps the Identity Services Engine ProfilerProfile API and exposes the API as native Python methods that return native Python objects.
Profiler Profile API allows the client to search profiles.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
1.2
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Example Values
name
String
Yes
Resource Name
2Wire-Device
id
String
No
Resource UUID, mandatory for update
fe8c7cc0-8bff-11e6-996c-525400b48521
description
String
No
Policy for 2Wire-Device
parentId
String
Yes
-
get_profiler_profile_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get a profiler profile by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_profiler_profile_by_id
-
get_profiler_profiles
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the profiler profiles. Filter: [name] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_profiler_profiles
-
get_profiler_profiles_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the profiler profiles. Filter: [name] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_profiler_profiles_generator
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the profiler profile.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
provider¶
-
class
Provider
[source]¶ Identity Services Engine Provider API (version: 3.1.1).
Wraps the Identity Services Engine Provider API and exposes the API as native Python methods that return native Python objects.
# Cisco ISE 3.0 pxGrid REST APIs
## License [Cisco Sample Code License](https://developer.cisco.com/site/license/cisco-sample-code-license/)
## Status These are the status icons for the requests so far. - ⌗ : must create resources to test - 🚧 : incomplete | untested - 🛑 : unsupported | bug
## Environment Variables This collection uses environment variables in scripts in the Tests tab to store data (id, name, portalId, etc.) between requests. This allows you to GET or POST then immediately GET {id} on a resource. Using No Environment will cause this convenience functionality to fail so be sure to choose one.
## Collection Variables This collection includes some default variables that you will want to update or override with environment variables for your ISE deployment. Specifically, you will want to set: - ise_pxg: the ISE PAN node name or IP address. Default: ise.securitydemo.net - rest_username: the username for ERS API access. Must be a member of SuperAdmin, ERSAdmin or ERSOperator groups. Default: admin which is the ISE SuperAdmin - rest_password: Default: C1sco12345
-
register_service
(name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ 🚧 ServiceRegister.
- Parameters
name (string) – name, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
unregister_service
(headers=None, **query_parameters)[source]¶ 🚧 ServiceUnregister.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
reregister_service
(headers=None, **query_parameters)[source]¶ 🚧 ServiceReregister.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
🚧 Authorization.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
psn_node_details_with_radius_service¶
-
class
PsnNodeDetailsWithRadiusService
[source]¶ Identity Services Engine PsnNodeDetailsWithRadiusService API (version: 3.1.1).
Wraps the Identity Services Engine PsnNodeDetailsWithRadiusService API and exposes the API as native Python methods that return native Python objects.
PSN Node Details with RADIUS Service API allows the client to get deployment node details where ‘Session Services’ is enabled.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.2
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Example Values
name
String
Yes
Resource Name
TestNode
id
String
No
Resource UUID, mandatory for update
ab6deded-fcc2-47ff-8577-0014737c8fcf
description
String
No
PSN with Session Service
ipAddress
String
Yes
10.0.0.1
-
get_session_service_node_by_name
(name, headers=None, **query_parameters)[source]¶ This API allows the client to get a PSN node details by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_name
(name, headers=None, **query_parameters)[source]¶ Alias for get_session_service_node_by_name
-
get_session_service_node_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get a PSN node details by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_session_service_node_by_id
-
get_session_service_node
(page=None, size=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the PSN node details.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_session_service_node
-
get_session_service_node_generator
(page=None, size=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the PSN node details.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_session_service_node_generator
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the PSN node.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
pull_deployment_info¶
-
class
PullDeploymentInfo
[source]¶ Identity Services Engine PullDeploymentInfo API (version: 3.1.1).
Wraps the Identity Services Engine PullDeploymentInfo API and exposes the API as native Python methods that return native Python objects.
Pull Deployment Info API allows clients to get the complete information about a Cisco ISE deployment. The information includes details about the deployment, network zccess, NADs, MDMs, licenses, posture and profiler.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.7
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
name
String
Yes
Resource Name
id
String
No
Resource UUID, mandatory for update
description
String
No
networkAccessInfo
List
No
networkAccessInfo Details
deploymentID
String
Yes
Deployment ID
isCsnEnabled
Boolean
Yes
false
nodeList
List
Yes
Node list
nodeAndScope
List
No
Includes ‘content’ which is an array of dictionaries describing various attributes with the properties:- name (String), - declaredType (String), - scope (String), - value (Varies), - nil (Boolean), - globalScope (Boolean), - typeSubstituted (Boolean)
sdaVNs
List
No
trustSecControl
String
No
ISE
radius3RdParty
List
No
profilerInfo
List
No
profilerInfo Details
deploymentID
String
Yes
Deployment ID
nodeList
List
Yes
Node list
node
List
No
Includes ‘profiles’ which is an array of dictionaries describing various attributes with the properties:- profile (List), - customProfilesCount (Integer), - endpointTypes (String), - totalProfilesCount (Integer), - uniqueEndpointsCount (Integer), - unknownEndpointsCount (Integer), - totalEndpointsCount (Integer), - unknownEndpointsPercentage (Integer)
deploymentInfo
List
No
deploymentInfo Details
deploymentID
String
Yes
Deployment ID
versionHistoryInfo
List
No
Array of dictionaries describing various attributes with the properties:- opType (String), - mainVersion (String), - epochTime (Integer)
nodeList
List
Yes
Node list
nodeAndNodeCountAndCountInfo
List
No
Includes ‘content’ which is an array of dictionaries describing various attributes with the properties:- name (String), - declaredType (String), - scope (String), - value (Varies), - nil (Boolean), - globalScope (Boolean), - typeSubstituted (Boolean)
fipsstatus
String
No
Disabled
nadInfo
List
No
nadInfo Details
deploymentID
String
Yes
Deployment ID
nodeList
List
Yes
Node list
nodeAndScope
List
No
Includes ‘content’ which is an array of dictionaries describing various attributes with the properties:- name (String), - declaredType (String), - scope (String), - value (List), - nil (Boolean), - globalScope (Boolean), - typeSubstituted (Boolean)
nadcountInfo
List
No
totalActiveNADCount
Integer
No
0
mdmInfo
List
No
mdmInfo Details
activeMdmServersCount
Integer
Yes
0
activeDesktopMdmServersCount
Integer
Yes
0
activeMobileMdmServersCount
Integer
Yes
0
deploymentID
String
Yes
Deployment ID
nodeList
List
Yes
Node list
nodeAndScope
List
No
Includes ‘content’ which is an array of dictionaries describing various attributes with the properties:- name (String), - declaredType (String), - scope (String), - value (Varies), - nil (Boolean), - globalScope (Boolean), - typeSubstituted (Boolean)
licensesInfo
List
No
licensesInfo Details
deploymentID
String
Yes
Deployment ID
nodeList
List
Yes
Node list
nodeAndScope
List
No
Includes ‘content’ which is an array of dictionaries describing various attributes with the properties:- name (String), - declaredType (String), - scope (String), - value (Varies), - nil (Boolean), - globalScope (Boolean), - typeSubstituted (Boolean)
postureInfo
List
No
postureInfo Details
content
List
Yes
Array of dictionaries describing various attributes with the properties:- name (String), - declaredType (String), - scope (String), - value (Varies), - nil (Boolean), - globalScope (Boolean), - typeSubstituted (Boolean)
kongInfo
List
No
kongInfo Details
deploymentID
String
Yes
Deployment ID
nodeList
List
Yes
Node list
node
List
No
Array of dictionaries describing various attributes with the properties:- sn (String), - service (List)
-
get_deployment_info
(timeout=None, headers=None, **query_parameters)[source]¶ This API allows the client to pull the deployment information.
- Parameters
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(timeout=None, headers=None, **query_parameters)[source]¶ Alias for get_deployment_info
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the pull deployment info.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
px_grid_settings¶
-
class
PxGridSettings
[source]¶ Identity Services Engine PxGridSettings API (version: 3.1.1).
Wraps the Identity Services Engine PxGridSettings API and exposes the API as native Python methods that return native Python objects.
pxGrid Settings API allows the client to change auto-approve settings for pxGrid nodes. Note: From Cisco ISE Release 3.1, all pxGrid connections must be based on pxGrid 2.0. pxGrid 1.0-based (XMPP-based) integrations will cease to work on Cisco ISE from Release 3.1 onwards. pxGrid Version 2.0, which is based on WebSockets, was introduced in Cisco ISE Release 2.4. We recommend that you plan and upgrade your other systems to pxGrid 2.0-compliant versions in order to prevent potential disruptions, if any, to integrations.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
3.0
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Default Values
Example Values
name
String
Yes
Resource Name
id
String
No
Resource UUID, mandatory for update
description
String
No
autoApproveCertBasedAccounts
Boolean
Yes
Auto approve certificate based accounts when true
false
true
allowPasswordBasedAccounts
Boolean
Yes
Allow password based acoounts when true
false
-
autoapprove_px_grid_settings
(allow_password_based_accounts=None, auto_approve_cert_based_accounts=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to auto approve the pxGrid settings.
- Parameters
allow_password_based_accounts (boolean) – Allow password based accounts when true, property of the request body.
auto_approve_cert_based_accounts (boolean) – Auto approve certificate based accounts when true, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
autoapprove
(allow_password_based_accounts=None, auto_approve_cert_based_accounts=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for autoapprove_px_grid_settings
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the pxGrid settings.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
radius_failure¶
-
class
RadiusFailure
[source]¶ Identity Services Engine RADIUS Failure API (version: 3.1.1).
Wraps the Identity Services Engine RADIUS Failure API and exposes the API as native Python methods that return native Python objects.
# Cisco ISE 3.0 pxGrid REST APIs
## License [Cisco Sample Code License](https://developer.cisco.com/site/license/cisco-sample-code-license/)
## Status These are the status icons for the requests so far. - ⌗ : must create resources to test - 🚧 : incomplete | untested - 🛑 : unsupported | bug
## Environment Variables This collection uses environment variables in scripts in the Tests tab to store data (id, name, portalId, etc.) between requests. This allows you to GET or POST then immediately GET {id} on a resource. Using No Environment will cause this convenience functionality to fail so be sure to choose one.
## Collection Variables This collection includes some default variables that you will want to update or override with environment variables for your ISE deployment. Specifically, you will want to set: - ise_pxg: the ISE PAN node name or IP address. Default: ise.securitydemo.net - rest_username: the username for ERS API access. Must be a member of SuperAdmin, ERSAdmin or ERSOperator groups. Default: admin which is the ISE SuperAdmin - rest_password: Default: C1sco12345
-
get_failures
(headers=None, **query_parameters)[source]¶ 🚧 getFailures.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
radius_server_sequence¶
-
class
RadiusServerSequence
[source]¶ Identity Services Engine RADIUSServerSequence API (version: 3.1.1).
Wraps the Identity Services Engine RADIUSServerSequence API and exposes the API as native Python methods that return native Python objects.
RADIUS Server Sequence API allows the client to add, delete, update, search and perform actions on RADIUS server sequence.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.3
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Default Values
Example Values
name
String
Yes
Resource Name
name
id
String
No
Resource UUID, mandatory for update
ab6deded-fcc2-47ff-8577-0014737c8fcf
description
String
No
description
stripPrefix
Boolean
No
false
stripSuffix
Boolean
No
false
prefixSeparator
String
No
The prefixSeparator is required only if stripPrefix is true. The maximum length is 1 character
suffixSeparator
String
No
The suffixSeparator is required only if stripSuffix is true. The maximum length is 1 character
@
remoteAccounting
Boolean
No
true
localAccounting
Boolean
No
false
useAttrSetOnRequest
Boolean
No
false
useAttrSetBeforeAcc
Boolean
No
false
continueAuthorzPolicy
Boolean
No
false
radiusServers
List
Yes
List with names of external radius server. The order of the names in the list is the order of servers that will be used during authentication
[ “externalRadiusServer1”, “externalRadiusServer2” ]
onRequestAttrManipulators
List
No
The onRequestAttrManipulators is required only if useAttrSetOnRequest is true
AttributeManipulator
List
No
action
Enum
Yes
Allowed Values: ADD, UPDATE, REMOVE, REMOVEANY
ADD
dictionaryName
String
Yes
Cisco
attributeName
String
Yes
cisco-prev-hop-ip
value
String
Yes
test1
changedVal
String
No
The changedVal is required only if the action equals to ‘UPDATE’
test2
beforeAcceptAttrManipulators
List
No
The beforeAcceptAttrManipulators is required only if useAttrSetBeforeAcc is true
AttributeManipulator
List
No
action
Enum
Yes
Allowed Values: ADD, UPDATE, REMOVE, REMOVEANY
ADD
dictionaryName
String
Yes
Cisco
attributeName
String
Yes
cisco-prev-hop-ip
value
String
Yes
test1
changedVal
String
No
The changedVal is required only if the action equals to ‘UPDATE’
test2
-
get_radius_server_sequence_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get a RADIUS server sequence by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_radius_server_sequence_by_id
-
update_radius_server_sequence_by_id
(id, before_accept_attr_manipulators_list=None, continue_authorz_policy=None, description=None, local_accounting=None, name=None, on_request_attr_manipulator_list=None, prefix_separator=None, radius_server_list=None, remote_accounting=None, strip_prefix=None, strip_suffix=None, suffix_separator=None, use_attr_set_before_acc=None, use_attr_set_on_request=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update a RADIUS server sequence.
- Parameters
before_accept_attr_manipulators_list (list) – The beforeAcceptAttrManipulators is required only if useAttrSetBeforeAcc is true, property of the request body (list of objects).
on_request_attr_manipulator_list (list) – The onRequestAttrManipulators is required only if useAttrSetOnRequest is true, property of the request body (list of objects).
radius_server_list (list) – RadiusServerList, property of the request body (list of strings).
continue_authorz_policy (boolean) – continueAuthorzPolicy, property of the request body.
description (string) – description, property of the request body.
id (basestring) – id, property of the request body.
local_accounting (boolean) – localAccounting, property of the request body.
name (string) – name, property of the request body.
prefix_separator (string) – The prefixSeparator is required only if stripPrefix is true. The maximum length is 1 character, property of the request body.
remote_accounting (boolean) – remoteAccounting, property of the request body.
strip_prefix (boolean) – stripPrefix, property of the request body.
strip_suffix (boolean) – stripSuffix, property of the request body.
suffix_separator (string) – The suffixSeparator is required only if stripSuffix is true. The maximum length is 1 character, property of the request body.
use_attr_set_before_acc (boolean) – useAttrSetBeforeAcc, property of the request body.
use_attr_set_on_request (boolean) – useAttrSetOnRequest, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, before_accept_attr_manipulators_list=None, continue_authorz_policy=None, description=None, local_accounting=None, name=None, on_request_attr_manipulator_list=None, prefix_separator=None, radius_server_list=None, remote_accounting=None, strip_prefix=None, strip_suffix=None, suffix_separator=None, use_attr_set_before_acc=None, use_attr_set_on_request=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_radius_server_sequence_by_id
-
delete_radius_server_sequence_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes a RADIUS server sequence.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_radius_server_sequence_by_id
-
get_radius_server_sequence
(page=None, size=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the RADIUS server sequences.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_radius_server_sequence
-
get_radius_server_sequence_generator
(page=None, size=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the RADIUS server sequences.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_radius_server_sequence_generator
-
create_radius_server_sequence
(before_accept_attr_manipulators_list=None, continue_authorz_policy=None, description=None, local_accounting=None, name=None, on_request_attr_manipulator_list=None, prefix_separator=None, radius_server_list=None, remote_accounting=None, strip_prefix=None, strip_suffix=None, suffix_separator=None, use_attr_set_before_acc=None, use_attr_set_on_request=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates a RADIUS server sequence.
- Parameters
before_accept_attr_manipulators_list (list) – The beforeAcceptAttrManipulators is required only if useAttrSetBeforeAcc is true, property of the request body (list of objects).
on_request_attr_manipulator_list (list) – The onRequestAttrManipulators is required only if useAttrSetOnRequest is true, property of the request body (list of objects).
radius_server_list (list) – RadiusServerList, property of the request body (list of strings).
continue_authorz_policy (boolean) – continueAuthorzPolicy, property of the request body.
description (string) – description, property of the request body.
local_accounting (boolean) – localAccounting, property of the request body.
name (string) – name, property of the request body.
prefix_separator (string) – The prefixSeparator is required only if stripPrefix is true. The maximum length is 1 character, property of the request body.
remote_accounting (boolean) – remoteAccounting, property of the request body.
strip_prefix (boolean) – stripPrefix, property of the request body.
strip_suffix (boolean) – stripSuffix, property of the request body.
suffix_separator (string) – The suffixSeparator is required only if stripSuffix is true. The maximum length is 1 character, property of the request body.
use_attr_set_before_acc (boolean) – useAttrSetBeforeAcc, property of the request body.
use_attr_set_on_request (boolean) – useAttrSetOnRequest, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(before_accept_attr_manipulators_list=None, continue_authorz_policy=None, description=None, local_accounting=None, name=None, on_request_attr_manipulator_list=None, prefix_separator=None, radius_server_list=None, remote_accounting=None, strip_prefix=None, strip_suffix=None, suffix_separator=None, use_attr_set_before_acc=None, use_attr_set_on_request=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_radius_server_sequence
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the RADIUS server sequence.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
restid_store¶
-
class
RestidStore
[source]¶ Identity Services Engine RESTIDStore API (version: 3.1.1).
Wraps the Identity Services Engine RESTIDStore API and exposes the API as native Python methods that return native Python objects.
REST ID Store API allows clients to add, get, update and delete REST ID stores.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
3.0
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Example Values
name
String
Yes
Resource Name
RestIdStore1
id
String
No
Resource UUID, mandatory for update
b1155994-b736-46af-9add-04bed3058e3a
description
String
No
Object that represents the restID storee
ersRestIDStoreAttributes
List
Yes
Holds the attributes of the restID object
usernameSuffix
String
Yes
Suffix of the username domain
@place.com
rootUrl
String
Yes
url of the root of the RestIDStore
rootUrl
predefined
Enum
Yes
The cloud provider connected to of the RestIDStore. Options are: - Azure, - Okta, - None
Azure
headers
List
Yes
Headers for the RestIDStore
key
String
Yes
Key of the header
tenantID
value
String
Yes
Value of the header
tenantID_value
-
get_rest_id_store_by_name
(name, headers=None, **query_parameters)[source]¶ This API allows the client to get a REST ID store by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_name
(name, headers=None, **query_parameters)[source]¶ Alias for get_rest_id_store_by_name
-
update_rest_id_store_by_name
(name, description=None, ers_rest_idstore_attributes=None, id=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update a REST ID store by name.
- Parameters
description (string) – description, property of the request body.
ers_rest_idstore_attributes (object) – ersRestIDStoreAttributes, property of the request body.
id (string) – id, property of the request body.
name (basestring) – name, property of the request body.
name – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_name
(name, description=None, ers_rest_idstore_attributes=None, id=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_rest_id_store_by_name
-
delete_rest_id_store_by_name
(name, headers=None, **query_parameters)[source]¶ This API deletes a REST ID store by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_name
(name, headers=None, **query_parameters)[source]¶ Alias for delete_rest_id_store_by_name
-
get_rest_id_store_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get a REST ID store by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_rest_id_store_by_id
-
update_rest_id_store_by_id
(id, description=None, ers_rest_idstore_attributes=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update a REST ID store.
- Parameters
description (string) – description, property of the request body.
ers_rest_idstore_attributes (object) – ersRestIDStoreAttributes, property of the request body.
id (basestring) – id, property of the request body.
name (string) – name, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, description=None, ers_rest_idstore_attributes=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_rest_id_store_by_id
-
delete_rest_id_store_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes a REST ID store.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_rest_id_store_by_id
-
get_rest_id_store
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the REST ID stores. Filter: [name] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_rest_id_store
-
get_rest_id_store_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the REST ID stores. Filter: [name] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_rest_id_store_generator
-
create_rest_id_store
(description=None, ers_rest_idstore_attributes=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates a REST ID store.
- Parameters
description (string) – description, property of the request body.
ers_rest_idstore_attributes (object) – ersRestIDStoreAttributes, property of the request body.
name (string) – name, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(description=None, ers_rest_idstore_attributes=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_rest_id_store
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the REST ID store.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
repository¶
-
class
Repository
[source]¶ Identity Services Engine Repository API (version: 3.1.1).
Wraps the Identity Services Engine Repository API and exposes the API as native Python methods that return native Python objects.
-
get_repositories
(headers=None, **query_parameters)[source]¶ This will get the full list of repository definitions on the system. .
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(headers=None, **query_parameters)[source]¶ Alias for get_repositories
-
create_repository
(enable_pki=None, name=None, password=None, path=None, protocol=None, server_name=None, user_name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Create a new repository in the system. The name provided for the repository must be unique. .
- Parameters
enable_pki (boolean) – enablePki, property of the request body.
name (string) – Repository name should be less than 80 characters and can contain alphanumeric, underscore, hyphen and dot characters., property of the request body.
password (string) – Password can contain alphanumeric and/or special characters., property of the request body.
path (string) – Path should always start with “/” and can contain alphanumeric, underscore, hyphen and dot characters., property of the request body.
protocol (string) – protocol, property of the request body. Available values are ‘CDROM’, ‘DISK’, ‘FTP’, ‘HTTP’, ‘HTTPS’, ‘NFS’, ‘SFTP’ and ‘TFTP’.
server_name (string) – serverName, property of the request body.
user_name (string) – Username may contain alphanumeric and _-./@$ characters., property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(enable_pki=None, name=None, password=None, path=None, protocol=None, server_name=None, user_name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_repository
-
get_repository
(repository_name, headers=None, **query_parameters)[source]¶ Get a specific repository identified by the name passed in the URL. .
- Parameters
repository_name (basestring) – repositoryName path parameter. Unique name for a repository.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_name
(repository_name, headers=None, **query_parameters)[source]¶ Alias for get_repository
-
update_repository
(repository_name, enable_pki=None, name=None, password=None, path=None, protocol=None, server_name=None, user_name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Update the definition of a specific repository, providing ALL parameters for the repository. .
- Parameters
enable_pki (boolean) – enablePki, property of the request body.
name (string) – Repository name should be less than 80 characters and can contain alphanumeric, underscore, hyphen and dot characters., property of the request body.
password (string) – Password can contain alphanumeric and/or special characters., property of the request body.
path (string) – Path should always start with “/” and can contain alphanumeric, underscore, hyphen and dot characters., property of the request body.
protocol (string) – protocol, property of the request body. Available values are ‘CDROM’, ‘DISK’, ‘FTP’, ‘HTTP’, ‘HTTPS’, ‘NFS’, ‘SFTP’ and ‘TFTP’.
server_name (string) – serverName, property of the request body.
user_name (string) – Username may contain alphanumeric and _-./@$ characters., property of the request body.
repository_name (basestring) – repositoryName path parameter. Unique name for a repository.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_name
(repository_name, enable_pki=None, name=None, password=None, path=None, protocol=None, server_name=None, user_name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_repository
-
delete_repository
(repository_name, headers=None, **query_parameters)[source]¶ Long description TBD .
- Parameters
repository_name (basestring) – repositoryName path parameter. Unique name for a repository.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_name
(repository_name, headers=None, **query_parameters)[source]¶ Alias for delete_repository
-
get_repository_files
(repository_name, headers=None, **query_parameters)[source]¶ This will get the full list of files present in the named repository. .
- Parameters
repository_name (basestring) – repositoryName path parameter. Unique name for a repository.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_files
(repository_name, headers=None, **query_parameters)[source]¶ Alias for get_repository_files
-
sms_provider¶
-
class
SmsProvider
[source]¶ Identity Services Engine SMSProvider API (version: 3.1.1).
Wraps the Identity Services Engine SMSProvider API and exposes the API as native Python methods that return native Python objects.
SMS Provider API allows the client to search the SMS providers configured from Cisco ISE GUI.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.2
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Example Values
name
String
Yes
Resource Name
name
id
String
No
Resource UUID, mandatory for update
b1155994-b736-46af-9add-04bed3058e3a
description
String
No
-
get_sms_provider
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the SMS providers. Filter: [name] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_sms_provider
-
get_sms_provider_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the SMS providers. Filter: [name] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_sms_provider_generator
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the SMS provider.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
sxp_connections¶
-
class
SxpConnections
[source]¶ Identity Services Engine SXPConnections API (version: 3.1.1).
Wraps the Identity Services Engine SXPConnections API and exposes the API as native Python methods that return native Python objects.
SXP Connections API allows clients to add, get, update and delete the Security Group Tag (SGT) Exchange Protocol (SXP) connections.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
Revision Modification
Revision Modification
Attribute
Description
0
1.0
2.0
Initial Cisco ISE Version
1
1.1
3.0
Cisco ISE 3.0 model changes
sxpVpn
Attribute can include some VPNs separated by comma
Resource Definition
Attribute
Type
Required
Description
Example Values
name
String
Yes
Resource Name
id
String
No
Resource UUID value
f9269682-dcaf-11e3-ad0a-5bdcd2d9fd69
description
String
No
Brief description about network peer
sxpPeer
String
Yes
Sxp Peer Name
sxpVpn
String
Yes
Sxp VPN Name
sxpNode
String
Yes
Sxp Node Name
ipAddress
String
Yes
Sxp Peer IP address
sxpMode
String
Yes
Sxp Mode
sxpVersion
String
Yes
Sxp Version
enabled
Boolean
Yes
true
-
get_sxp_connections_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get a SXP connection by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_sxp_connections_by_id
-
update_sxp_connections_by_id
(id, description=None, enabled=None, ip_address=None, sxp_mode=None, sxp_node=None, sxp_peer=None, sxp_version=None, sxp_vpn=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update a SXP connection.
- Parameters
description (string) – description, property of the request body.
enabled (boolean) – enabled, property of the request body.
id (basestring) – id, property of the request body.
ip_address (string) – ipAddress, property of the request body.
sxp_mode (string) – sxpMode, property of the request body.
sxp_node (string) – sxpNode, property of the request body.
sxp_peer (string) – sxpPeer, property of the request body.
sxp_version (string) – sxpVersion, property of the request body.
sxp_vpn (string) – sxpVpn, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, description=None, enabled=None, ip_address=None, sxp_mode=None, sxp_node=None, sxp_peer=None, sxp_version=None, sxp_vpn=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_sxp_connections_by_id
-
delete_sxp_connections_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes a SXP connection.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_sxp_connections_by_id
-
get_sxp_connections
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the SXP connections. Filter: [name, description] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_sxp_connections
-
get_sxp_connections_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the SXP connections. Filter: [name, description] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_sxp_connections_generator
-
create_sxp_connections
(description=None, enabled=None, ip_address=None, sxp_mode=None, sxp_node=None, sxp_peer=None, sxp_version=None, sxp_vpn=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates a SXP connection.
- Parameters
description (string) – description, property of the request body.
enabled (boolean) – enabled, property of the request body.
ip_address (string) – ipAddress, property of the request body.
sxp_mode (string) – sxpMode, property of the request body.
sxp_node (string) – sxpNode, property of the request body.
sxp_peer (string) – sxpPeer, property of the request body.
sxp_version (string) – sxpVersion, property of the request body.
sxp_vpn (string) – sxpVpn, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(description=None, enabled=None, ip_address=None, sxp_mode=None, sxp_node=None, sxp_peer=None, sxp_version=None, sxp_vpn=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_sxp_connections
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the SXP connections.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
bulk_request_for_sxp_connections
(operation_type=None, resource_media_type=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to submit the bulk request.
- Parameters
operation_type (string) – operationType, property of the request body.
resource_media_type (string) – resourceMediaType, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
bulk_request
(operation_type=None, resource_media_type=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for bulk_request_for_sxp_connections
-
monitor_bulk_status_sxp_connections
(bulkid, headers=None, **query_parameters)[source]¶ This API allows the client to monitor the bulk request.
- Parameters
bulkid (basestring) – bulkid path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
monitor_bulk_status
(bulkid, headers=None, **query_parameters)[source]¶ Alias for monitor_bulk_status_sxp_connections
-
sxp_local_bindings¶
-
class
SxpLocalBindings
[source]¶ Identity Services Engine SXPLocalBindings API (version: 3.1.1).
Wraps the Identity Services Engine SXPLocalBindings API and exposes the API as native Python methods that return native Python objects.
SXP Local Bindings API allows clients to add, get, update and delete SGT static mappings.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
Revision Modification
Revision Modification
Attribute
Description
0
1.0
2.0
Initial Cisco ISE Version
1
1.1
3.0
Cisco ISE 3.0 model changes
vns
Added new property for the Virtual Networks
Resource Definition
Attribute
Type
Required
Description
Example Values
name
String
Yes
Resource Name
id
String
No
Resource UUID value
f9269682-dcaf-11e3-ad0a-5bdcd2d9fd69
description
String
No
bindingName
String
No
This field is depricated from Cisco ISE 3.0
ipAddressOrHost
String
Yes
IP address for static mapping (hostname is not supported)
ipAddressOrHost
sgt
String
Yes
SGT name or ID
sgt_id
sxpVpn
String
Yes
List of SXP Domains, separated with comma. At least one of: sxpVpn or vns should be defined
Sxp Vpn Name
vns
String
Yes
List of Virtual Networks, separated with comma. At least one of: sxpVpn or vns should be defined
virtualNetwork
-
get_sxp_local_bindings_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get a SXP local binding by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_sxp_local_bindings_by_id
-
update_sxp_local_bindings_by_id
(id, binding_name=None, description=None, ip_address_or_host=None, sgt=None, sxp_vpn=None, vns=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update a SXP local binding.
- Parameters
binding_name (string) – This field is depricated from Cisco ISE 3.0, property of the request body.
description (string) – description, property of the request body.
id (basestring) – id, property of the request body.
ip_address_or_host (string) – IP address for static mapping (hostname is not supported), property of the request body.
sgt (string) – SGT name or ID, property of the request body.
sxp_vpn (string) – List of SXP Domains, separated with comma. At least one of: sxpVpn or vns should be defined, property of the request body.
vns (string) – List of Virtual Networks, separated with comma. At least one of: sxpVpn or vns should be defined, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, binding_name=None, description=None, ip_address_or_host=None, sgt=None, sxp_vpn=None, vns=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_sxp_local_bindings_by_id
-
delete_sxp_local_bindings_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes a SXP local binding.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_sxp_local_bindings_by_id
-
get_sxp_local_bindings
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the SXP local bindings. Filter: [name, description] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_sxp_local_bindings
-
get_sxp_local_bindings_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the SXP local bindings. Filter: [name, description] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_sxp_local_bindings_generator
-
create_sxp_local_bindings
(binding_name=None, description=None, id=None, ip_address_or_host=None, sgt=None, sxp_vpn=None, vns=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates a SXP local binding.
- Parameters
binding_name (string) – This field is depricated from Cisco ISE 3.0, property of the request body.
description (string) – description, property of the request body.
id (string) – id, property of the request body.
ip_address_or_host (string) – IP address for static mapping (hostname is not supported), property of the request body.
sgt (string) – SGT name or ID, property of the request body.
sxp_vpn (string) – List of SXP Domains, separated with comma. At least one of: sxpVpn or vns should be defined, property of the request body.
vns (string) – List of Virtual Networks, separated with comma. At least one of: sxpVpn or vns should be defined, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(binding_name=None, description=None, id=None, ip_address_or_host=None, sgt=None, sxp_vpn=None, vns=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_sxp_local_bindings
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the SXP local bindings.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
bulk_request_for_sxp_local_bindings
(operation_type=None, resource_media_type=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to submit the bulk request.
- Parameters
operation_type (string) – operationType, property of the request body.
resource_media_type (string) – resourceMediaType, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
bulk_request
(operation_type=None, resource_media_type=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for bulk_request_for_sxp_local_bindings
-
monitor_bulk_status_sxp_local_bindings
(bulkid, headers=None, **query_parameters)[source]¶ This API allows the client to monitor the bulk request.
- Parameters
bulkid (basestring) – bulkid path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
monitor_bulk_status
(bulkid, headers=None, **query_parameters)[source]¶ Alias for monitor_bulk_status_sxp_local_bindings
-
sxp_vpns¶
-
class
SxpVpns
[source]¶ Identity Services Engine SXPVPNs API (version: 3.1.1).
Wraps the Identity Services Engine SXPVPNs API and exposes the API as native Python methods that return native Python objects.
SXP VPNs API allows clients to add, get and delete SXP VPNs (SXP Domains).Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.0
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Example Values
name
String
Yes
Resource Name
id
String
No
Resource UUID value
ef36ca16-0cf7-4806-b2a9-6f547cfe4805
description
String
No
sxpVpnName
String
Yes
default
-
get_sxp_vpn_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get a SXP VPN by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_sxp_vpn_by_id
-
delete_sxp_vpn_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes a SXP VPN.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_sxp_vpn_by_id
-
get_sxp_vpns
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the SXP VPNs. Filter: [name, description] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_sxp_vpns
-
get_sxp_vpns_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the SXP VPNs. Filter: [name, description] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_sxp_vpns_generator
-
create_sxp_vpn
(sxp_vpn_name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates a SXP VPN.
- Parameters
sxp_vpn_name (string) – sxpVpnName, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(sxp_vpn_name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_sxp_vpn
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the SXP VPNs.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
bulk_request_for_sxp_vpns
(operation_type=None, resource_media_type=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to submit the bulk request.
- Parameters
operation_type (string) – operationType, property of the request body.
resource_media_type (string) – resourceMediaType, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
bulk_request
(operation_type=None, resource_media_type=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for bulk_request_for_sxp_vpns
-
monitor_bulk_status_sxp_vpns
(bulkid, headers=None, **query_parameters)[source]¶ This API allows the client to monitor the bulk request.
- Parameters
bulkid (basestring) – bulkid path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
monitor_bulk_status
(bulkid, headers=None, **query_parameters)[source]¶ Alias for monitor_bulk_status_sxp_vpns
-
security_group_to_virtual_network¶
-
class
SecurityGroupToVirtualNetwork
[source]¶ Identity Services Engine SecurityGroupToVirtualNetwork API (version: 3.1.1).
Wraps the Identity Services Engine SecurityGroupToVirtualNetwork API and exposes the API as native Python methods that return native Python objects.
SGT mapping to virtual networks are mapped to referenced vlan. These constructs come from out side of Cisco ISE and are not CRUDable inside Cisco ISE.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.3
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Example Values
name
String
Yes
Resource Name
name
id
String
No
Resource UUID, mandatory for update
1af3d6e2-cc3b-4603-b80f-6827768335ab
description
String
No
description
sgtId
String
No
sgt_id
virtualnetworklist
List
No
Includes ‘vlans’ which is an array of dictionaries describing various attributes with the properties: - id (String), - name (String), - description (String), - defaultVlan (Boolean), - maxValue (Integer), - data (Boolean)
“id” : “1af3d6e2-cc3b-4603-b80f-6827768335ab”, “name” : “virtual1”, “description” : “description”, “defaultVirtualNetwork” : false, “vlans” : [ { “id” : “1af3d6e2-cc3b-4603-b80f-6827768335ab”, “name” : “vlan1”, “description” : “description1”, “defaultVlan” : true, “maxValue” : 1882725260, “data” : true } ] } ]
-
get_security_groups_to_vn_to_vlan_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get a security group to virtual network by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_security_groups_to_vn_to_vlan_by_id
-
update_security_groups_to_vn_to_vlan_by_id
(id, description=None, name=None, sgt_id=None, virtualnetworklist=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update a security group to virtual network.
- Parameters
description (string) – description, property of the request body.
id (basestring) – id, property of the request body.
name (string) – name, property of the request body.
sgt_id (string) – sgtId, property of the request body.
virtualnetworklist (list) – virtualnetworklist, property of the request body (list of objects).
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, description=None, name=None, sgt_id=None, virtualnetworklist=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
-
delete_security_groups_to_vn_to_vlan_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes a security group ACL to virtual network.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_security_groups_to_vn_to_vlan
(filter=None, filter_type=None, page=None, size=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the security group ACL to virtual networks. Filter: [sgtId] To search guest users by using toDate column,follow the format: DD- MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 .
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_security_groups_to_vn_to_vlan
-
get_security_groups_to_vn_to_vlan_generator
(filter=None, filter_type=None, page=None, size=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the security group ACL to virtual networks. Filter: [sgtId] To search guest users by using toDate column,follow the format: DD- MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 .
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, headers=None, **query_parameters)[source]¶
-
create_security_groups_to_vn_to_vlan
(description=None, id=None, name=None, sgt_id=None, virtualnetworklist=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates a security group to virtual network.
- Parameters
description (string) – description, property of the request body.
id (string) – id, property of the request body.
name (string) – name, property of the request body.
sgt_id (string) – sgtId, property of the request body.
virtualnetworklist (list) – virtualnetworklist, property of the request body (list of objects).
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(description=None, id=None, name=None, sgt_id=None, virtualnetworklist=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_security_groups_to_vn_to_vlan
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the security group to virtual network.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
bulk_request_for_security_groups_to_vn_to_vlan
(operation_type=None, resource_media_type=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to submit the bulk request.
- Parameters
operation_type (string) – operationType, property of the request body.
resource_media_type (string) – resourceMediaType, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
bulk_request
(operation_type=None, resource_media_type=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
-
monitor_bulk_status_security_groups_to_vn_to_vlan
(bulkid, headers=None, **query_parameters)[source]¶ This API allows the client to monitor the bulk request.
- Parameters
bulkid (basestring) – bulkid path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
security_groups¶
-
class
SecurityGroups
[source]¶ Identity Services Engine SecurityGroups API (version: 3.1.1).
Wraps the Identity Services Engine SecurityGroups API and exposes the API as native Python methods that return native Python objects.
SGT API allows the client to search SGTs.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
Revision Modification
Revision Modification
Attribute
Description
0
1.0
1.2
Initial Cisco ISE Version
1
1.1
1.4
Cisco ISE 1.4 model changes
isTagFromRange
Removed Attribute isTagFromRange - depricated - set to FALSE value by default
2
1.2
2.3
Cisco ISE 2.3 model changes
propogateToApic
Added Boolean Attribute propogateToApic - By default value is false
3
1.3
2.7
Cisco ISE 2.7 model changes
isReadOnly
Added Boolean Attribute isReadOnly - By default value is false
defaultSGACLs
Added List Attribute defaultSGACLs
Resource Definition
Attribute
Type
Required
Description
Default Values
Example Values
name
String
Yes
Resource Name
Employees
id
String
No
Resource UUID, mandatory for update
93ad6890-8c01-11e6-996c-525400b48521
description
String
No
Employee Security Group
value
Integer
Yes
Value range: 2 ot 65519 or -1 to auto-generate
4
propogateToApic
Boolean
No
true
isReadOnly
Boolean
No
false
defaultSGACLs
List
No
[ ]
propogateToApic
Boolean
No
true
generationId
Integer
No
0
-
get_security_group_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get a security group by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_security_group_by_id
-
update_security_group_by_id
(id, default_sgacls=None, description=None, generation_id=None, is_read_only=None, name=None, propogate_to_apic=None, value=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update a security group.
- Parameters
default_sgacls (list) – defaultSGACLs, property of the request body (list of objects).
description (string) – description, property of the request body.
generation_id (string) – generationId, property of the request body.
id (basestring) – id, property of the request body.
is_read_only (boolean) – isReadOnly, property of the request body.
name (string) – name, property of the request body.
propogate_to_apic (boolean) – propogateToApic, property of the request body.
value (integer) – Value range: 2 ot 65519 or -1 to auto- generate, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, default_sgacls=None, description=None, generation_id=None, is_read_only=None, name=None, propogate_to_apic=None, value=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_security_group_by_id
-
delete_security_group_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes a security group.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_security_group_by_id
-
get_security_groups
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the security groups. Filter: [propogateToApic, name, description, value] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description, value].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_security_groups
-
get_security_groups_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the security groups. Filter: [propogateToApic, name, description, value] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description, value].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_security_groups_generator
-
create_security_group
(default_sgacls=None, description=None, generation_id=None, is_read_only=None, name=None, propogate_to_apic=None, value=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates a security group.
- Parameters
default_sgacls (list) – defaultSGACLs, property of the request body (list of objects).
description (string) – description, property of the request body.
generation_id (string) – generationId, property of the request body.
is_read_only (boolean) – isReadOnly, property of the request body.
name (string) – name, property of the request body.
propogate_to_apic (boolean) – propogateToApic, property of the request body.
value (integer) – Value range: 2 ot 65519 or -1 to auto- generate, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(default_sgacls=None, description=None, generation_id=None, is_read_only=None, name=None, propogate_to_apic=None, value=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_security_group
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the security groups.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
bulk_request_for_security_group
(operation_type=None, resource_media_type=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to submit the bulk request.
- Parameters
operation_type (string) – operationType, property of the request body.
resource_media_type (string) – resourceMediaType, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
bulk_request
(operation_type=None, resource_media_type=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for bulk_request_for_security_group
-
monitor_bulk_status_security_group
(bulkid, headers=None, **query_parameters)[source]¶ This API allows the client to monitor the bulk request.
- Parameters
bulkid (basestring) – bulkid path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
monitor_bulk_status
(bulkid, headers=None, **query_parameters)[source]¶ Alias for monitor_bulk_status_security_group
-
security_groups_acls¶
-
class
SecurityGroupsAcls
[source]¶ Identity Services Engine SecurityGroupsACLs API (version: 3.1.1).
Wraps the Identity Services Engine SecurityGroupsACLs API and exposes the API as native Python methods that return native Python objects.
Security Groups ACLs API allows the client to search security groups access control lists.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
Revision Modification
Revision Modification
Attribute
Description
0
1.0
2.0
Initial Cisco ISE Version
1
1.1
2.3
Introducing bulk operations
2
1.2
3.1
Cisco ISE 3.1 model changes
modelledContent
Adding modelled content from Cisco ISE 3.1
Resource Definition
Attribute
Type
Required
Description
Default Values
Example Values
name
String
Yes
Resource Name
Permit IP
id
String
No
Resource UUID, mandatory for update
92951ac0-8c01-11e6-996c-525400b48521
description
String
No
Permit IP SGACL
ACLContent
String
No
permit ip
ipVersion
Enum
Yes
Allowed values: IPV4, IPV6, IP_AGNOSTIC
IPV4
isReadOnly
Boolean
No
false
generationId
String
No
GenerationId is a read only attribute and is being generated by the server
0
modelledContent
List
No
Modelled content of contract
-
get_security_groups_acl_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get a security group ACL by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_security_groups_acl_by_id
-
update_security_groups_acl_by_id
(id, aclcontent=None, description=None, generation_id=None, ip_version=None, is_read_only=None, modelled_content=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update a security group ACL.
- Parameters
aclcontent (string) – aclcontent, property of the request body.
description (string) – description, property of the request body.
generation_id (string) – generationId, property of the request body.
id (basestring) – id, property of the request body.
ip_version (string) – Allowed values: IPV4, IPV6, IP_AGNOSTIC, property of the request body.
is_read_only (boolean) – isReadOnly, property of the request body.
modelled_content (object) – Modelled content of contract, property of the request body.
name (string) – name, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, aclcontent=None, description=None, generation_id=None, ip_version=None, is_read_only=None, modelled_content=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_security_groups_acl_by_id
-
delete_security_groups_acl_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes a security group ACL.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_security_groups_acl_by_id
-
get_security_groups_acl
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the security group ACLs. Filter: [ipVersion, name, description] To search guest users by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [ipVersion, name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_security_groups_acl
-
get_security_groups_acl_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the security group ACLs. Filter: [ipVersion, name, description] To search guest users by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [ipVersion, name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_security_groups_acl_generator
-
create_security_groups_acl
(aclcontent=None, description=None, generation_id=None, ip_version=None, is_read_only=None, modelled_content=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates a security group ACL.
- Parameters
aclcontent (string) – aclcontent, property of the request body.
description (string) – description, property of the request body.
generation_id (string) – generationId, property of the request body.
ip_version (string) – Allowed values: IPV4, IPV6, IP_AGNOSTIC, property of the request body.
is_read_only (boolean) – isReadOnly, property of the request body.
modelled_content (object) – Modelled content of contract, property of the request body.
name (string) – name, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(aclcontent=None, description=None, generation_id=None, ip_version=None, is_read_only=None, modelled_content=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_security_groups_acl
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the security group ACLs.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
bulk_request_for_security_groups_acl
(operation_type=None, resource_media_type=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to submit the bulk request.
- Parameters
operation_type (string) – operationType, property of the request body.
resource_media_type (string) – resourceMediaType, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
bulk_request
(operation_type=None, resource_media_type=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for bulk_request_for_security_groups_acl
-
monitor_bulk_status_security_groups_acl
(bulkid, headers=None, **query_parameters)[source]¶ This API allows the client to monitor the bulk request.
- Parameters
bulkid (basestring) – bulkid path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
monitor_bulk_status
(bulkid, headers=None, **query_parameters)[source]¶ Alias for monitor_bulk_status_security_groups_acl
-
self_registered_portal¶
-
class
SelfRegisteredPortal
[source]¶ Identity Services Engine SelfRegisteredPortal API (version: 3.1.1).
Wraps the Identity Services Engine SelfRegisteredPortal API and exposes the API as native Python methods that return native Python objects.
Self Registered Guest Portal API provides the ability to create, read, update, delete and search self registered portals.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.2
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Default Values
Example Values
name
String
Yes
Resource Name
Self-Registered Guest Portal (default)
id
String
No
Resource UUID, mandatory for update
4e8ade36-4048-472a-b345-632cc155acfc
description
String
No
Guests may create their own accounts and be assigned a username and password, or use their social login to access the network
portalTestUrl
String
No
URL to bring up a test page for this portal
https://{ise-ip}:8443/portal/PortalSetup.action?portal=4e8ade36-4048-472a-b345-632cc155acfc
portalType
Enum
Yes
Allowed values: BYOD, HOTSPOTGUEST, MYDEVICE, SELFREGGUEST, SPONSOR, SPONSOREDGUEST
SELFREGGUEST
settings
List
No
Defines all of the settings groups available for a portal
portalSettings
List
No
The port, interface, certificate, and other basic settings of a portal
httpsPort
Integer
Yes
The port number that the allowed interfaces will listen on. Range from 8000 to 8999
8443
allowedInterfaces
Enum
Yes
Interfaces that the portal will be reachable on.
[ “eth0”, “bond0” ]
certificateGroupTag
String
Yes
Logical name of the x.509 server certificate that will be used for the portal
Default Portal Certificate Group
authenticationMethod
String
Yes
Unique Id of the identity source sequence
92e50f80-8c01-11e6-996c-525400b48521
assignedGuestTypeForEmployee
String
Yes
Unique Id of a guest type. Employees using this portal as a guest inherit login options from the guest type
Contractor (default)
displayLang
Enum
No
Allowed values: USEBROWSERLOCALE, ALWAYSUSE
USEBROWSERLOCALE
fallbackLanguage
String
No
Used when displayLang = USEBROWSERLOCALE
English
alwaysUsedLanguage
String
No
Used when displayLang = ALWAYSUSE
English
loginPageSettings
List
No
Portal Login Page settings groups follow
maxFailedAttemptsBeforeRateLimit
Integer
No
Maximum failed login attempts before rate limiting
5
timeBetweenLoginsDuringRateLimit
Integer
No
Time between login attempts when rate limiting
2
includeAup
Boolean
No
Include an Acceptable Use Policy (AUP) that should be displayed during login
false
aupDisplay
Enum
No
How the AUP should be displayed, either on page or as a link. Only valid if includeAup = true.
ASLINK
requireAupAcceptance
Boolean
No
Require the portal user to accept the AUP. Only valid if includeAup = true
false
requireAccessCode
Boolean
No
Require the portal user to enter an access code
false
accessCode
String
No
Access code that must be entered by the portal user (only valid if requireAccessCode = true)
allowGuestToCreateAccounts
Boolean
No
false
allowGuestToChangePassword
Boolean
No
Require the portal user to enter an access code
false
allowAlternateGuestPortal
Boolean
No
false
alternateGuestPortal
String
No
selfRegPageSettings
List
No
assignGuestsToGuestType
String
No
Guests are assigned to this guest type
accountValidityDuration
Integer
No
Self-registered guest account is valid for this many account_validity_time_units
1
accountValidityTimeUnits
Enum
No
Time units for account_validity_duration.
DAYS
requireRegistrationCode
Boolean
No
Self-registered guests are required to enter a registration code
false
registrationCode
String
No
The registration code that the guest user must enter
fieldUserName
List
No
include
Boolean
No
true
require
Boolean
No
Only applicable if include = true
false
fieldFirstName
List
No
include
Boolean
No
true
require
Boolean
No
Only applicable if include = true
false
fieldLastName
List
No
include
Boolean
No
true
require
Boolean
No
Only applicable if include = true
false
fieldEmailAddr
List
No
include
Boolean
No
true
require
Boolean
No
Only applicable if include = true
false
fieldPhoneNo
List
No
include
Boolean
No
true
require
Boolean
No
Only applicable if include = true
false
fieldCompany
List
No
include
Boolean
No
true
require
Boolean
No
Only applicable if include = true
false
fieldLocation
List
No
include
Boolean
No
true
require
Boolean
No
Only applicable if include = true
false
selectableLocations
List
No
Guests can choose from these locations to set their time zone
[“San Jose”]
fieldSmsProvider
List
No
include
Boolean
No
true
require
Boolean
No
Only applicable if include = true
false
selectableSmsProviders
List
No
This attribute is an array of SMS provider names
[“Global Default”]
fieldPersonBeingVisited
List
No
include
Boolean
No
true
require
Boolean
No
Only applicable if include = true
false
fieldReasonForVisit
List
No
include
Boolean
No
true
require
Boolean
No
Only applicable if include = true
false
includeAup
Boolean
No
Include an Acceptable Use Policy (AUP) that should be displayed during login
false
aupDisplay
Enum
No
How the AUP should be displayed, either on page or as a link. Only valid if includeAup = true.
ASLINK
requireAupAcceptance
Boolean
No
Require the portal user to accept the AUP. Only valid if includeAup = true
false
enableGuestEmailWhitelist
Boolean
No
Allow guests with an e-mail address from selected domains
false
guestEmailWhitelistDomains
List
No
Self-registered guests whose e-mail address is in one of these domains will be allowed. Only valid if enableGuestEmailWhitelist = true
enableGuestEmailBlacklist
Boolean
No
Disallow guests with an e-mail address from selected domains
false
guestEmailBlacklistDomains
List
No
Self-registered guests whose e-mail address is in one of these domains will be disallowed. Only valid if enableGuestEmailBlacklist = true
requireGuestApproval
Boolean
No
Require self-registered guests to be approved if true
false
autoLoginSelfWait
Boolean
No
Allow guests to login automatically from self-registration after sponsor’s approval. No need to provide the credentials by guest to login
false
autoLoginTimePeriod
Integer
No
Waiting period for auto login until sponsor’s approval. If time exceeds, guest has to login manually by providing the credentials. Default value is 5 minutes
5
sendApprovalRequestTo
Enum
No
Specifies where approval requests are sent. Only valid if requireGuestApproval = true.
SELECTEDEMAILADDRESSES
approvalEmailAddresses
String
No
Only valid if requireGuestApproval = true and sendApprovalRequestTo = SELECTEDEMAILADDRESSES
postRegistrationRedirect
Enum
No
After the registration submission direct the guest user to one of the following pages. Only valid if requireGuestApproval = true.
SELFREGISTRATIONSUCCESS
postRegistrationRedirectUrl
String
No
URL where guest user is redirected after registration. Only valid if requireGuestApproval = true and postRegistrationRedirect = URL
credentialNotificationUsingEmail
Boolean
No
If true, send credential notification upon approval using email. Only valid if requireGuestApproval = true
false
credentialNotificationUsingSms
Boolean
No
If true, send credential notification upon approval using SMS. Only valid if requireGuestApproval = true
false
approveDenyLinksValidFor
Integer
No
This attribute, along with approveDenyLinksTimeUnits, specifies how long the link can be used. Only valid if requireGuestApproval = true
1440
approveDenyLinksTimeUnits
Enum
No
This attribute, along with approveDenyLinksValidFor, specifies how long the link can be used. Only valid if requireGuestApproval = true.
DAYS
requireApproverToAuthenticate
Boolean
No
When self-registered guests require approval, an approval request is e-mailed to one or more sponsor users. If the Cisco ISE Administrator chooses to include an approval link in the e-mail, a sponsor user who clicks the link will be required to enter their username and password if this attribute is true. Only valid if requireGuestApproval = true
false
sponsorPortalList
List
No
When self-registered guests require approval, an approval request is e-mailed to one or more sponsor users. If the Cisco ISE Administrator chooses to include an approval link in the e-mail, a sponsor user who clicks the link will be authenticated against the selected sponsor portals in the order specified. Only valid if requireGuestApproval = true. The array should contain the names of the selected portals
selfRegSuccessSettings
List
No
includeUserName
Boolean
No
true
includePassword
Boolean
No
true
includeFirstName
Boolean
No
true
includeLastName
Boolean
No
true
includeEmailAddr
Boolean
No
true
includePhoneNo
Boolean
No
true
includeCompany
Boolean
No
true
includeLocation
Boolean
No
true
includeSmsProvider
Boolean
No
true
includePersonBeingVisited
Boolean
No
true
includeReasonForVisit
Boolean
No
true
allowGuestSendSelfUsingPrint
Boolean
No
false
allowGuestSendSelfUsingEmail
Boolean
No
false
allowGuestSendSelfUsingSms
Boolean
No
false
includeAup
Boolean
No
false
aupOnPage
Boolean
No
false
requireAupAcceptance
Boolean
No
false
requireAupScrolling
Boolean
No
false
allowGuestLoginFromSelfregSuccessPage
Boolean
No
false
aupSettings
List
No
Configuration of the Acceptable Use Policy (AUP) for a portal
displayFrequency
Enum
No
How the AUP should be displayed, either on page or as a link. Only valid if includeAup = true.
FIRSTLOGIN
includeAup
Boolean
No
Require the portal user to read and accept an AUP
true
requireAupScrolling
Boolean
No
Require the portal user to scroll to the end of the AUP. Only valid if requireAupAcceptance = true
false
useDiffAupForEmployees
Boolean
No
Only valid if requireAupAcceptance = trueG
false
skipAupForEmployees
Boolean
No
Only valid if requireAupAcceptance = true
false
displayFrequencyIntervalDays
Integer
No
Number of days between AUP confirmations (when displayFrequency = recurring)
7
GuestChangePasswordSettings
List
No
allowChangePasswdAtFirstLogin
Boolean
No
Allow guest to change their own passwords
false
guestDeviceRegistrationSettings
List
No
autoRegisterGuestDevices
Boolean
No
Automatically register guest devices
true
allowGuestsToRegisterDevices
Boolean
No
Allow guests to register devices
false
byodSettings
List
No
Configuration of BYOD Device Welcome, Registration and Success steps
byodWelcomeSettings
List
No
Configuration of BYOD endpoint welcome step configuration
enableBYOD
Boolean
No
true
enableGuestAccess
Boolean
No
false
requireMDM
Boolean
No
false
includeAup
Boolean
No
true
aupDisplay
Enum
No
How the AUP should be displayed, either on page or as a link. Only valid if includeAup = true.
ONPAGE
requireAupAcceptance
Boolean
No
false
requireScrolling
Boolean
No
Require BYOD devices to scroll down to the bottom of the AUP, Only valid if includeAup = true
false
byodRegistrationSettings
List
No
Configuration of BYOD endpoint Registration step configuration
showDeviceID
Boolean
No
Display Device ID field during registration
true
endPointIdentityGroupId
String
No
Identity group id for which endpoint belongs
aa13bb40-8bff-11e6-996c-525400b48521
byodRegistrationSuccessSettings
List
No
Configuration of BYOD endpoint Registration Success step configuration
successRedirect
Enum
No
After an Authentication Success where should device be redirected.
AUTHSUCCESSPAGE
redirectUrl
String
No
Target URL for redirection, used when successRedirect = URL
authSuccessSettings
List
No
successRedirect
Enum
No
After an Authentication Success where should device be redirected.
AUTHSUCCESSPAGE
redirectUrl
String
No
Target URL for redirection, used when successRedirect = URL
www.cisco.com
postLoginBannerSettings
List
No
includePostAccessBanner
Boolean
No
Include a Post-Login Banner page
false
supportInfoSettings
List
No
Portal Support Information Settings
includeSupportInfoPage
Boolean
No
false
includeMacAddr
Boolean
No
false
includeIpAddress
Boolean
No
false
includeBrowserUserAgent
Boolean
No
false
includePolicyServer
Boolean
No
false
includeFailureCode
Boolean
No
false
emptyFieldDisplay
Enum
No
Specifies how empty fields are handled on the Support Information Page.
HIDE
defaultEmptyFieldValue
String
No
The default value displayed for an empty field Only valid when emptyFieldDisplay = DISPLAYWITHDEFAULTVALUE
customizations
List
No
Defines all of the Portal Customizations available
portalTheme
List
No
Defines the configuration for portal theme
id
String
No
The unique internal identifier of the portal theme
9eb421c0-8c01-11e6-996c-525400b48521
name
String
Yes
The system- or user-assigned name of the portal theme
Default Blue theme
themeData
String
No
A CSS file, represented as a Base64-encoded byte array
Base 64 encoded string of Theme CSS file
portalTweakSettings
List
No
The Tweak Settings are a customization of the Portal Theme that has been selected for the portal. When the Portal Theme selection is changed, the Tweak Settings are overwritten to match the values in the theme. The Tweak Settings can subsequently be changed by the user
bannerColor
String
No
Hex value of color
#0000FF
bannerTextColor
String
No
Banner Text color code from GUI
pageBackgroundColor
String
No
Color code from GUI
pageLabelAndTextColor
String
No
Label and Text color from GUI
language
List
No
This property is supported only for Read operation and it allows to show the customizations in English. Other languages are not supported
viewLanguage
String
No
English
globalCustomizations
List
No
Represent the portal Global customizations
bannerTitle
String
No
Guest Portal
contactText
String
No
Contact Support
footerElement
String
No
Footer Element
mobileLogoImage
Image
No
data
String
No
Represented as base 64 encoded string of the image byte array
base 64 encoded value of image
desktopLogoImage
Image
No
data
String
No
Represented as base 64 encoded string of the image byte array
base 64 encoded value of image
bannerImage
Image
No
data
String
No
Represented as base 64 encoded string of the image byte array
base 64 encoded value of image
backgroundImage
Image
No
data
String
No
Represented as base 64 encoded string of the image byte array
base 64 encoded value of image
pageCustomizations
List
No
Represent the entire page customization as a giant dictionary
data
List
No
The Dictionary will be exposed here as key value pair
key
String
Yes
ui_contact_ip_address_label
value
String
Yes
SVAgYWRkcmVzczo=
-
get_self_registered_portal_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get a self registered portal by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_self_registered_portal_by_id
-
update_self_registered_portal_by_id
(id, customizations=None, description=None, name=None, portal_test_url=None, portal_type=None, settings=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update a self registered portal by ID.
- Parameters
customizations (object) – Defines all of the Portal Customizations available, property of the request body.
description (string) – description, property of the request body.
id (basestring) – id, property of the request body.
name (string) – name, property of the request body.
portal_test_url (string) – URL to bring up a test page for this portal, property of the request body.
portal_type (string) – Allowed values: BYOD, HOTSPOTGUEST, MYDEVICE, SELFREGGUEST, SPONSOR, SPONSOREDGUEST, property of the request body.
settings (object) – Defines all of the settings groups available for a portal, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, customizations=None, description=None, name=None, portal_test_url=None, portal_type=None, settings=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_self_registered_portal_by_id
-
delete_self_registered_portal_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes a self registered portal by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_self_registered_portal_by_id
-
get_self_registered_portals
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the self registered portals. Filter: [name] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_self_registered_portals
-
get_self_registered_portals_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the self registered portals. Filter: [name] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_self_registered_portals_generator
-
create_self_registered_portal
(customizations=None, description=None, name=None, portal_test_url=None, portal_type=None, settings=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates a self registered portal.
- Parameters
customizations (object) – Defines all of the Portal Customizations available, property of the request body.
description (string) – description, property of the request body.
name (string) – name, property of the request body.
portal_test_url (string) – URL to bring up a test page for this portal, property of the request body.
portal_type (string) – Allowed values: BYOD, HOTSPOTGUEST, MYDEVICE, SELFREGGUEST, SPONSOR, SPONSOREDGUEST, property of the request body.
settings (object) – Defines all of the settings groups available for a portal, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(customizations=None, description=None, name=None, portal_test_url=None, portal_type=None, settings=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_self_registered_portal
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the self registered portal.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
session_directory¶
-
class
SessionDirectory
[source]¶ Identity Services Engine Session Directory API (version: 3.1.1).
Wraps the Identity Services Engine Session Directory API and exposes the API as native Python methods that return native Python objects.
# Cisco ISE 3.0 pxGrid REST APIs
## License [Cisco Sample Code License](https://developer.cisco.com/site/license/cisco-sample-code-license/)
## Status These are the status icons for the requests so far. - ⌗ : must create resources to test - 🚧 : incomplete | untested - 🛑 : unsupported | bug
## Environment Variables This collection uses environment variables in scripts in the Tests tab to store data (id, name, portalId, etc.) between requests. This allows you to GET or POST then immediately GET {id} on a resource. Using No Environment will cause this convenience functionality to fail so be sure to choose one.
## Collection Variables This collection includes some default variables that you will want to update or override with environment variables for your ISE deployment. Specifically, you will want to set: - ise_pxg: the ISE PAN node name or IP address. Default: ise.securitydemo.net - rest_username: the username for ERS API access. Must be a member of SuperAdmin, ERSAdmin or ERSOperator groups. Default: admin which is the ISE SuperAdmin - rest_password: Default: C1sco12345
-
get_sessions
(headers=None, **query_parameters)[source]¶ 🚧 getSessions.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_sessions_for_recovery
(headers=None, **query_parameters)[source]¶ 🚧 getSessionsForRecovery.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_session_by_ip_address
(headers=None, **query_parameters)[source]¶ 🚧 getSessionByIpAddress.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_session_by_mac_address
(headers=None, **query_parameters)[source]¶ 🚧 getSessionByMacAddress.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_user_groups
(headers=None, **query_parameters)[source]¶ 🚧 getUserGroups.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_user_group_by_user_name
(headers=None, **query_parameters)[source]¶ 🚧 getUserGroupByUserName.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_name
(headers=None, **query_parameters)[source]¶ Alias for get_user_group_by_user_name
-
sponsor_group¶
-
class
SponsorGroup
[source]¶ Identity Services Engine SponsorGroup API (version: 3.1.1).
Wraps the Identity Services Engine SponsorGroup API and exposes the API as native Python methods that return native Python objects.
Sponsor Group API allows the client to add, delete, update and search sponsor groups.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.2
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Default Values
Example Values
name
String
Yes
Resource Name
EmplALL_ACCOUNTS (default)oyees
id
String
No
Resource UUID, mandatory for update
9f1eca71-8c01-11e6-996c-525400b48521
description
String
No
Sponsors assigned to this group can manage all guest user accounts. By default, users in the ALL_ACCOUNTS user identity group are members of this sponsor group
isEnabled
Boolean
No
true
isDefaultGroup
Boolean
No
true
memberGroups
List
No
[“ALL_ACCOUNTS (default)”]
guestTypes
List
No
[“Contractor (default)”, “Daily (default)”, “Weekly (default)” ]
locations
List
No
[“San Jose”]
autoNotification
Boolean
No
false
managePermission
Enum
No
Allowed values:
ALLACCOUNTS, GROUPACCOUNTS, OWNACCOUNTS
createPermissions
List
No
canImportMultipleAccounts
Boolean
No
true
importBatchSizeLimit
Integer
No
200
canCreateRandomAccounts
Boolean
No
true
randomBatchSizeLimit
Integer
No
200
defaultUsernamePrefix
String
No
canSpecifyUsernamePrefix
Boolean
No
true
canSetFutureStartDate
Boolean
No
false
startDateFutureLimitDays
Integer
No
1
otherPermissions
List
No
canUpdateGuestContactInfo
Boolean
No
true
canViewGuestPasswords
Boolean
No
true
canSendSmsNotifications
Boolean
No
false
canResetGuestPasswords
Boolean
No
true
canExtendGuestAccounts
Boolean
No
true
canDeleteGuestAccounts
Boolean
No
true
canSuspendGuestAccounts
Boolean
Yes
true
requireSuspensionReason
Boolean
No
false
canReinstateSuspendedAccounts
Boolean
No
true
canApproveSelfregGuests
Boolean
No
true
limitApprovalToSponsorsGuests
Boolean
Yes
false
canAccessViaRest
Boolean
No
false
-
get_sponsor_group_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get a sponsor group by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_sponsor_group_by_id
-
update_sponsor_group_by_id
(id, auto_notification=None, create_permissions=None, description=None, guest_types=None, is_default_group=None, is_enabled=None, locations=None, manage_permission=None, member_groups=None, name=None, other_permissions=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update a sponsor group by ID.
- Parameters
auto_notification (boolean) – autoNotification, property of the request body.
create_permissions (object) – createPermissions, property of the request body.
description (string) – description, property of the request body.
guest_types (list) – guestTypes, property of the request body (list of strings).
id (basestring) – id, property of the request body.
is_default_group (boolean) – isDefaultGroup, property of the request body.
is_enabled (boolean) – isEnabled, property of the request body.
locations (list) – locations, property of the request body (list of strings).
manage_permission (string) – managePermission, property of the request body.
member_groups (list) – memberGroups, property of the request body (list of strings).
name (string) – name, property of the request body.
other_permissions (object) – otherPermissions, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, auto_notification=None, create_permissions=None, description=None, guest_types=None, is_default_group=None, is_enabled=None, locations=None, manage_permission=None, member_groups=None, name=None, other_permissions=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_sponsor_group_by_id
-
delete_sponsor_group_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes a sponsor group by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_sponsor_group_by_id
-
get_sponsor_group
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the sponsor groups. Filter: [name] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_sponsor_group
-
get_sponsor_group_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the sponsor groups. Filter: [name] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_sponsor_group_generator
-
create_sponsor_group
(auto_notification=None, create_permissions=None, description=None, guest_types=None, is_default_group=None, is_enabled=None, locations=None, manage_permission=None, member_groups=None, name=None, other_permissions=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates a sponsor group.
- Parameters
auto_notification (boolean) – autoNotification, property of the request body.
create_permissions (object) – createPermissions, property of the request body.
description (string) – description, property of the request body.
guest_types (list) – guestTypes, property of the request body (list of strings).
is_default_group (boolean) – isDefaultGroup, property of the request body.
is_enabled (boolean) – isEnabled, property of the request body.
locations (list) – locations, property of the request body (list of strings).
manage_permission (string) – managePermission, property of the request body.
member_groups (list) – memberGroups, property of the request body (list of strings).
name (string) – name, property of the request body.
other_permissions (object) – otherPermissions, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(auto_notification=None, create_permissions=None, description=None, guest_types=None, is_default_group=None, is_enabled=None, locations=None, manage_permission=None, member_groups=None, name=None, other_permissions=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_sponsor_group
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the sponsor group.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
sponsor_group_member¶
-
class
SponsorGroupMember
[source]¶ Identity Services Engine SponsorGroupMember API (version: 3.1.1).
Wraps the Identity Services Engine SponsorGroupMember API and exposes the API as native Python methods that return native Python objects.
Sponsor Group API allows the client to search the group members from different identity stores configured in the GUI.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.2
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Example Values
name
String
Yes
Resource Name
ALL_ACCOUNTS (default)
id
String
No
Resource UUID value
a176c430-8c01-11e6-996c-525400b48521
description
String
No
dicType
String
Yes
guid
String
Yes
-
get_sponsor_group_member
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the sponsor group members. Filter: [name] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_sponsor_group_member
-
get_sponsor_group_member_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the sponsor group members. Filter: [name] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_sponsor_group_member_generator
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the sponsor group member.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
sponsor_portal¶
-
class
SponsorPortal
[source]¶ Identity Services Engine SponsorPortal API (version: 3.1.1).
Wraps the Identity Services Engine SponsorPortal API and exposes the API as native Python methods that return native Python objects.
Sponsor Portal API provides the ability to create, read, update, delete and search sponsor portals.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.2
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Default Values
Example Values
name
String
Yes
Resource Name
Sponsor Portal (default)
id
String
No
Resource UUID, mandatory for update
04cd708b-feef-4c75-bf3e-2d2a9c302da2
description
String
No
Default portal used by sponsors to create and manage accounts for authorized visitors to securely access the network
portalTestUrl
String
No
URL to bring up a test page for this portal
https://{ise-ip}:8445/portal/PortalSetup.action?portal=04cd708b-feef-4c75-bf3e-2d2a9c302da2
portalType
Enum
Yes
Allowed values: BYOD, HOTSPOTGUEST, MYDEVICE, SELFREGGUEST, SPONSOR, SPONSOREDGUEST
SPONSOR
settings
List
No
Defines all of the settings groups available for a portal
portalSettings
List
No
The port, interface, certificate, and other basic settings of a portal
httpsPort
Integer
Yes
The port number that the allowed interfaces will listen on. Range from 8000 to 8999
8445
allowedInterfaces
Enum
Yes
Interfaces that the portal will be reachable on.
[ “eth0”, “bond0” ]
certificateGroupTag
String
Yes
Logical name of the x.509 server certificate that will be used for the portal
Default Portal Certificate Group
fqdn
String
No
The fully-qualified domain name (FQDN) that end-users will use to access this portal. Used only in Sponsor portal
Default Portal Certificate Group
authenticationMethod
String
Yes
Unique Id of the identity source sequence
92faba60-8c01-11e6-996c-525400b48521
idleTimeout
Integer
No
10
displayLang
Enum
No
Allowed values: USEBROWSERLOCALE, ALWAYSUSE
USEBROWSERLOCALE
fallbackLanguage
String
No
Used when displayLang = USEBROWSERLOCALE
English
alwaysUsedLanguage
String
No
Used when displayLang = ALWAYSUSE
English
availableSsids
List
No
Names of the SSIDs available for assignment to guest users by sponsors
loginPageSettings
List
No
Portal Login Page settings groups follow
maxFailedAttemptsBeforeRateLimit
Integer
No
Maximum failed login attempts before rate limiting
5
timeBetweenLoginsDuringRateLimit
Integer
No
Time between login attempts when rate limiting
2
includeAup
Boolean
No
Include an Acceptable Use Policy (AUP) that should be displayed during login
false
aupDisplay
Enum
No
How the AUP should be displayed, either on page or as a link. Only valid if includeAup = true.
ASLINK
requireAupAcceptance
Boolean
No
Require the portal user to accept the AUP. Only valid if includeAup = true
false
aupSettings
List
No
Configuration of the Acceptable Use Policy (AUP) for a portal
displayFrequency
Enum
No
How the AUP should be displayed, either on page or as a link. Only valid if includeAup = true.
FIRSTLOGIN
includeAup
Boolean
No
Require the portal user to read and accept an AUP
true
requireAupScrolling
Boolean
No
Require the portal user to scroll to the end of the AUP. Only valid if requireAupAcceptance = true
false
displayFrequencyIntervalDays
Integer
No
Number of days between AUP confirmations (when displayFrequency = recurring)
7
sponsorChangePasswordSettings
List
No
allowSponsorToChangePwd
Boolean
No
Allow sponsors to change their own passwords
false
postLoginBannerSettings
List
No
includePostAccessBanner
Boolean
No
Include a Post-Login Banner page
false
supportInfoSettings
List
No
Portal Support Information Settings
includeSupportInfoPage
Boolean
No
false
includeMacAddr
Boolean
No
false
includeIpAddress
Boolean
No
false
includeBrowserUserAgent
Boolean
No
false
includePolicyServer
Boolean
No
false
includeFailureCode
Boolean
No
false
emptyFieldDisplay
Enum
No
Specifies how empty fields are handled on the Support Information Page.
HIDE
defaultEmptyFieldValue
String
No
The default value displayed for an empty field Only valid when emptyFieldDisplay = DISPLAYWITHDEFAULTVALUE
customizations
List
No
Defines all of the Portal Customizations available
portalTheme
List
No
Defines the configuration for portal theme
id
String
No
The unique internal identifier of the portal theme
9eb421c0-8c01-11e6-996c-525400b48521
name
String
Yes
The system- or user-assigned name of the portal theme
Default Blue theme
themeData
String
No
A CSS file, represented as a Base64-encoded byte array
Base 64 encoded string of Theme CSS file
portalTweakSettings
List
No
The Tweak Settings are a customization of the Portal Theme that has been selected for the portal. When the Portal Theme selection is changed, the Tweak Settings are overwritten to match the values in the theme. The Tweak Settings can subsequently be changed by the user
bannerColor
String
No
Hex value of color
#0000FF
bannerTextColor
String
No
Banner Text color code from GUI
pageBackgroundColor
String
No
Color code from GUI
pageLabelAndTextColor
String
No
Label and Text color from GUI
language
List
No
This property is supported only for Read operation and it allows to show the customizations in English. Other languages are not supported
viewLanguage
String
No
English
globalCustomizations
List
No
Represent the portal Global customizations
bannerTitle
String
No
Guest Portal
contactText
String
No
Contact Support
footerElement
String
No
Footer Element
mobileLogoImage
Image
No
data
String
No
Represented as base 64 encoded string of the image byte array
base 64 encoded value of image
desktopLogoImage
Image
No
data
String
No
Represented as base 64 encoded string of the image byte array
base 64 encoded value of image
bannerImage
Image
No
data
String
No
Represented as base 64 encoded string of the image byte array
base 64 encoded value of image
backgroundImage
Image
No
data
String
No
Represented as base 64 encoded string of the image byte array
base 64 encoded value of image
pageCustomizations
List
No
Represent the entire page customization as a giant dictionary
data
List
No
The Dictionary will be exposed here as key value pair
key
String
Yes
ui_contact_ip_address_label
value
String
Yes
SVAgYWRkcmVzczo=
-
get_sponsor_portal_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get a sponsor portal by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_sponsor_portal_by_id
-
update_sponsor_portal_by_id
(id, customizations=None, description=None, name=None, portal_test_url=None, portal_type=None, settings=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update a sponsor portal by ID.
- Parameters
customizations (object) – customizations, property of the request body.
description (string) – description, property of the request body.
id (basestring) – id, property of the request body.
name (string) – name, property of the request body.
portal_test_url (string) – URL to bring up a test page for this portal, property of the request body.
portal_type (string) – Allowed values: BYOD, HOTSPOTGUEST, MYDEVICE, SELFREGGUEST, SPONSOR, SPONSOREDGUEST, property of the request body.
settings (object) – Defines all of the settings groups available for a portal, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, customizations=None, description=None, name=None, portal_test_url=None, portal_type=None, settings=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_sponsor_portal_by_id
-
delete_sponsor_portal_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes a sponsor portal by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_sponsor_portal_by_id
-
get_sponsor_portal
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the sponsor portals. Filter: [name, description] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_sponsor_portal
-
get_sponsor_portal_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the sponsor portals. Filter: [name, description] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_sponsor_portal_generator
-
create_sponsor_portal
(customizations=None, description=None, name=None, portal_test_url=None, portal_type=None, settings=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates a sponsor portal.
- Parameters
customizations (object) – customizations, property of the request body.
description (string) – description, property of the request body.
name (string) – name, property of the request body.
portal_test_url (string) – URL to bring up a test page for this portal, property of the request body.
portal_type (string) – Allowed values: BYOD, HOTSPOTGUEST, MYDEVICE, SELFREGGUEST, SPONSOR, SPONSOREDGUEST, property of the request body.
settings (object) – Defines all of the settings groups available for a portal, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(customizations=None, description=None, name=None, portal_test_url=None, portal_type=None, settings=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_sponsor_portal
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the sponsor portal.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
sponsored_guest_portal¶
-
class
SponsoredGuestPortal
[source]¶ Identity Services Engine SponsoredGuestPortal API (version: 3.1.1).
Wraps the Identity Services Engine SponsoredGuestPortal API and exposes the API as native Python methods that return native Python objects.
Sponsored Guest Portal API provides the ability to create, read, update, delete and search sponsored guest portals.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.2
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Default Values
Example Values
name
String
Yes
Resource Name
Sponsored Guest Portal (default))
id
String
No
Resource UUID, mandatory for update
d135de9f-cd87-4ce7-b1a4-1d9c7cf35f33
description
String
No
Sponsors create guest accounts, and guests access the network using their assigned username and password
portalTestUrl
String
No
URL to bring up a test page for this portal
https://{ise-ip}:8443/portal/PortalSetup.action?portal=d135de9f-cd87-4ce7-b1a4-1d9c7cf35f33
portalType
Enum
Yes
Allowed values: BYOD, HOTSPOTGUEST, MYDEVICE, SELFREGGUEST, SPONSOR, SPONSOREDGUEST
SPONSOREDGUEST
settings
List
No
Defines all of the settings groups available for a portal
portalSettings
List
No
The port, interface, certificate, and other basic settings of a portal
httpsPort
Integer
Yes
The port number that the allowed interfaces will listen on. Range from 8000 to 8999
8443
allowedInterfaces
Enum
Yes
Interfaces that the portal will be reachable on. Allowed values: eth0, eth1, eth2, eth3, eth4, eth5, bond0, bond1, bond2
[ “eth0”, “bond0” ]
certificateGroupTag
String
Yes
Logical name of the x.509 server certificate that will be used for the portal
Default Portal Certificate Group
authenticationMethod
String
Yes
Unique Id of the identity source sequence
92faba60-8c01-11e6-996c-525400b48521
assignedGuestTypeForEmployee
String
Yes
Unique Id of a guest type. Employees using this portal as a guest inherit login options from the guest type
Contractor (default)
displayLang
Enum
No
Allowed values: USEBROWSERLOCALE, ALWAYSUSE
USEBROWSERLOCALE
fallbackLanguage
String
No
Used when displayLang = USEBROWSERLOCALE
English
alwaysUsedLanguage
String
No
Used when displayLang = ALWAYSUSE
English
loginPageSettings
List
No
Portal Login Page settings groups follow
maxFailedAttemptsBeforeRateLimit
Integer
No
Maximum failed login attempts before rate limiting
5
timeBetweenLoginsDuringRateLimit
Integer
No
Time between login attempts when rate limiting
2
includeAup
Boolean
No
Include an Acceptable Use Policy (AUP) that should be displayed during login
false
aupDisplay
Enum
No
How the AUP should be displayed, either on page or as a link. Only valid if includeAup = true. Allowed values: ONPAGE, ASLINK
ASLINK
requireAupAcceptance
Boolean
No
Require the portal user to accept the AUP. Only valid if includeAup = true
false
requireAccessCode
Boolean
No
Require the portal user to enter an access code
false
accessCode
String
No
Access code that must be entered by the portal user (only valid if requireAccessCode = true)
allowGuestToCreateAccounts
Boolean
No
false
allowGuestToChangePassword
Boolean
No
Require the portal user to enter an access code
false
aupSettings
List
No
Configuration of the Acceptable Use Policy (AUP) for a portal
displayFrequency
Enum
No
How the AUP should be displayed, either on page or as a link. Only valid if includeAup = true. Allowed Values: FIRSTLOGIN, EVERYLOGIN, RECURRING
FIRSTLOGIN
includeAup
Boolean
No
Require the portal user to read and accept an AUP
true
requireAupScrolling
Boolean
No
Require the portal user to scroll to the end of the AUP. Only valid if requireAupAcceptance = true
false
useDiffAupForEmployees
Boolean
No
Only valid if requireAupAcceptance = trueG
false
skipAupForEmployees
Boolean
No
Only valid if requireAupAcceptance = true
false
displayFrequencyIntervalDays
Integer
No
Number of days between AUP confirmations (when displayFrequency = recurring)
7
GuestChangePasswordSettings
List
No
allowChangePasswdAtFirstLogin
Boolean
No
Allow guest to change their own passwords
false
guestDeviceRegistrationSettings
List
No
autoRegisterGuestDevices
Boolean
No
Automatically register guest devices
true
allowGuestsToRegisterDevices
Boolean
No
Allow guests to register devices
false
byodSettings
List
No
Configuration of BYOD Device Welcome, Registration and Success steps
byodWelcomeSettings
List
No
Configuration of BYOD endpoint welcome step configuration
enableBYOD
Boolean
No
true
enableGuestAccess
Boolean
No
false
requireMDM
Boolean
No
false
includeAup
Boolean
No
true
aupDisplay
Enum
No
How the AUP should be displayed, either on page or as a link. Only valid if includeAup = true. Allowed values: ONPAGE, ASLINK
ONPAGE
requireAupAcceptance
Boolean
No
false
requireScrolling
Boolean
No
Require BYOD devices to scroll down to the bottom of the AUP, Only valid if includeAup = true
false
byodRegistrationSettings
List
No
Configuration of BYOD endpoint Registration step configuration
showDeviceID
Boolean
No
Display Device ID field during registration
true
endPointIdentityGroupId
String
No
Identity group id for which endpoint belongs
aa13bb40-8bff-11e6-996c-525400b48521
byodRegistrationSuccessSettings
List
No
Configuration of BYOD endpoint Registration Success step configuration
successRedirect
Enum
No
After an Authentication Success where should device be redirected. Allowed values: AUTHSUCCESSPAGE, ORIGINATINGURL, URL
AUTHSUCCESSPAGE
redirectUrl
String
No
Target URL for redirection, used when successRedirect = URL
authSuccessSettings
List
No
successRedirect
Enum
No
After an Authentication Success where should device be redirected. Allowed values: AUTHSUCCESSPAGE, ORIGINATINGURL, URL
AUTHSUCCESSPAGE
redirectUrl
String
No
Target URL for redirection, used when successRedirect = URL
www.cisco.com
postLoginBannerSettings
List
No
includePostAccessBanner
Boolean
No
Include a Post-Login Banner page
false
supportInfoSettings
List
No
Portal Support Information Settings
includeSupportInfoPage
Boolean
No
false
includeMacAddr
Boolean
No
false
includeIpAddress
Boolean
No
false
includeBrowserUserAgent
Boolean
No
false
includePolicyServer
Boolean
No
false
includeFailureCode
Boolean
No
false
emptyFieldDisplay
Enum
No
Specifies how empty fields are handled on the Support Information Page. Allowed values: HIDE, DISPLAYWITHNOVALUE, DISPLAYWITHDEFAULTVALUE
HIDE
defaultEmptyFieldValue
String
No
The default value displayed for an empty field Only valid when emptyFieldDisplay = DISPLAYWITHDEFAULTVALUE
customizations
List
No
Defines all of the Portal Customizations available
portalTheme
List
No
Defines the configuration for portal theme
id
String
No
The unique internal identifier of the portal theme
9eb421c0-8c01-11e6-996c-525400b48521
name
String
Yes
The system- or user-assigned name of the portal theme
Default Blue theme
themeData
String
No
A CSS file, represented as a Base64-encoded byte array
Base 64 encoded string of Theme CSS file
portalTweakSettings
List
No
The Tweak Settings are a customization of the Portal Theme that has been selected for the portal. When the Portal Theme selection is changed, the Tweak Settings are overwritten to match the values in the theme. The Tweak Settings can subsequently be changed by the user
bannerColor
String
No
Hex value of color
#0000FF
bannerTextColor
String
No
Banner Text color code from GUI
pageBackgroundColor
String
No
Color code from GUI
pageLabelAndTextColor
String
No
Label and Text color from GUI
language
List
No
This property is supported only for Read operation and it allows to show the customizations in English. Other languages are not supported
viewLanguage
String
No
English
globalCustomizations
List
No
Represent the portal Global customizations
bannerTitle
String
No
Guest Portal
contactText
String
No
Contact Support
footerElement
String
No
Footer Element
mobileLogoImage
Image
No
data
String
No
Represented as base 64 encoded string of the image byte array
base 64 encoded value of image
desktopLogoImage
Image
No
data
String
No
Represented as base 64 encoded string of the image byte array
base 64 encoded value of image
bannerImage
Image
No
data
String
No
Represented as base 64 encoded string of the image byte array
base 64 encoded value of image
backgroundImage
Image
No
data
String
No
Represented as base 64 encoded string of the image byte array
base 64 encoded value of image
pageCustomizations
List
No
Represent the entire page customization as a giant dictionary
data
List
No
The Dictionary will be exposed here as key value pair
key
String
Yes
ui_contact_ip_address_label
value
String
Yes
SVAgYWRkcmVzczo=
-
get_sponsored_guest_portal_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get a sponsored guest portal by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_sponsored_guest_portal_by_id
-
update_sponsored_guest_portal_by_id
(id, customizations=None, description=None, name=None, portal_test_url=None, portal_type=None, settings=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update a sponsored guest portal by ID.
- Parameters
customizations (object) – Defines all of the Portal Customizations available, property of the request body.
description (string) – description, property of the request body.
id (basestring) – id, property of the request body.
name (string) – name, property of the request body.
portal_test_url (string) – URL to bring up a test page for this portal, property of the request body.
portal_type (string) – Allowed values: BYOD, HOTSPOTGUEST, MYDEVICE, SELFREGGUEST, SPONSOR, SPONSOREDGUEST, property of the request body.
settings (object) – Defines all of the settings groups available for a portal, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, customizations=None, description=None, name=None, portal_test_url=None, portal_type=None, settings=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_sponsored_guest_portal_by_id
-
delete_sponsored_guest_portal_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes a sponsored guest portal by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_sponsored_guest_portal_by_id
-
get_sponsored_guest_portals
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the sponsored guest portals. Filter: [name, description] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_sponsored_guest_portals
-
get_sponsored_guest_portals_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the sponsored guest portals. Filter: [name, description] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_sponsored_guest_portals_generator
-
create_sponsored_guest_portal
(customizations=None, description=None, name=None, portal_test_url=None, portal_type=None, settings=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates a sponsored guest portal.
- Parameters
customizations (object) – Defines all of the Portal Customizations available, property of the request body.
description (string) – description, property of the request body.
name (string) – name, property of the request body.
portal_test_url (string) – URL to bring up a test page for this portal, property of the request body.
portal_type (string) – Allowed values: BYOD, HOTSPOTGUEST, MYDEVICE, SELFREGGUEST, SPONSOR, SPONSOREDGUEST, property of the request body.
settings (object) – Defines all of the settings groups available for a portal, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(customizations=None, description=None, name=None, portal_test_url=None, portal_type=None, settings=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_sponsored_guest_portal
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the sponsored guest portal.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
support_bundle_download¶
-
class
SupportBundleDownload
[source]¶ Identity Services Engine SupportBundleDownload API (version: 3.1.1).
Wraps the Identity Services Engine SupportBundleDownload API and exposes the API as native Python methods that return native Python objects.
Support Bundle Download API allows client to download support bundles provided those are generated and available in the default location.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.7
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Example Values
name
String
Yes
Resource Name
id
String
No
Resource UUID, mandatory for update
description
String
No
fileName
String
Yes
File name along with path from where file needs to be downloaded
filename
-
download_support_bundle
(file_name=None, dirpath=None, save_file=None, filename=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to upload a support bundle.
- Parameters
file_name (string) – fileName, property of the request body.
dirpath (basestring) – Directory absolute path. Defaults to os.getcwd().
save_file (bool) – Enable or disable automatic file creation of raw response.
filename (basestring) – The filename used to save the download file.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
The DownloadResponse wrapper. Wraps the urllib3.response.HTTPResponse. For more information check the urlib3 documentation
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
DownloadFailure – If was not able to download the raw
response to a file. –
-
download
(file_name=None, dirpath=None, save_file=None, filename=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for download_support_bundle
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the support bundle download.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
support_bundle_status¶
-
class
SupportBundleStatus
[source]¶ Identity Services Engine SupportBundleStatus API (version: 3.1.1).
Wraps the Identity Services Engine SupportBundleStatus API and exposes the API as native Python methods that return native Python objects.
Support Bundle Status API allows clients to query status of a triggered support bundle.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.7
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Example Values
name
String
Yes
Resource Name
ciscoise
id
String
No
Resource UUID, mandatory for update
ciscoise
description
String
No
Support Bundle Status api
fileName
String
No
ise-support-bundle-pk-ciscoise-admin-04-09-2021-15-07.tar.gpg
fileSize
Integer
No
1080924274
hostName
String
No
ciscoise
message
String
No
Support Bundle generation completed
startTime
String
No
Fri Apr 09 15:07:55 IST 2021
status
String
No
complete
-
get_support_bundle_status_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get a support bundle status by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_support_bundle_status_by_id
-
get_support_bundle_status
(page=None, size=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the support bundle status.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_support_bundle_status
-
get_support_bundle_status_generator
(page=None, size=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the support bundle status.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_support_bundle_status_generator
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the support bundle status.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
support_bundle_trigger_configuration¶
-
class
SupportBundleTriggerConfiguration
[source]¶ Identity Services Engine SupportBundleTriggerConfiguration API (version: 3.1.1).
Wraps the Identity Services Engine SupportBundleTriggerConfiguration API and exposes the API as native Python methods that return native Python objects.
Support Bundle Trigger API allows clients to trigger support bundle provided the log settings are given using which the support needs to be generated.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.7
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Default Values
name
String
Yes
Resource Name
supportBundle
id
String
No
Resource UUID, mandatory for update
1af3d6e2-cc3b-4603-b80f-6827768335ab
description
String
No
Support Bundle Generation
hostName
String
Yes
This parameter is hostName only, xxxx of xxxx.yyy.zz
sampleHost
supportBundleOptions
List
Yes
includeConfigDB
Boolean
Yes
Set to include Config DB in Support Bundle
false
includeDebugLogs
Boolean
Yes
Set to include Debug logs in Support Bundle
false
includeLocalLogs
Boolean
Yes
Set to include Local logs in Support Bundle
false
includeCoreFiles
Boolean
Yes
Set to include Core files in Support Bundle
false
includeSystemLogs
Boolean
Yes
Set to include System logs in Support Bundle
false
mntLogs
Boolean
Yes
Set to include Monitoring and troublshooting logs in Support Bundle
false
policyXml
Boolean
Yes
Set to include Policy XML in Support Bundle
false
fromDate
Date
No
Date from where support bundle should include the logs
04/21/2019
toDate
Date
No
Date upto where support bundle should include the logs
04/22/2019
-
create_support_bundle
(description=None, host_name=None, name=None, support_bundle_include_options=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to create a support bundle trigger configuration.
- Parameters
description (string) – description, property of the request body.
host_name (string) – This parameter is hostName only, xxxx of xxxx.yyy.zz, property of the request body.
name (string) – Resource Name, property of the request body.
support_bundle_include_options (object) – supportBundleIncludeOptions, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(description=None, host_name=None, name=None, support_bundle_include_options=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_support_bundle
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the support bundle trigger configuration.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
system_health¶
-
class
SystemHealth
[source]¶ Identity Services Engine System Health API (version: 3.1.1).
Wraps the Identity Services Engine System Health API and exposes the API as native Python methods that return native Python objects.
# Cisco ISE 3.0 pxGrid REST APIs
## License [Cisco Sample Code License](https://developer.cisco.com/site/license/cisco-sample-code-license/)
## Status These are the status icons for the requests so far. - ⌗ : must create resources to test - 🚧 : incomplete | untested - 🛑 : unsupported | bug
## Environment Variables This collection uses environment variables in scripts in the Tests tab to store data (id, name, portalId, etc.) between requests. This allows you to GET or POST then immediately GET {id} on a resource. Using No Environment will cause this convenience functionality to fail so be sure to choose one.
## Collection Variables This collection includes some default variables that you will want to update or override with environment variables for your ISE deployment. Specifically, you will want to set: - ise_pxg: the ISE PAN node name or IP address. Default: ise.securitydemo.net - rest_username: the username for ERS API access. Must be a member of SuperAdmin, ERSAdmin or ERSOperator groups. Default: admin which is the ISE SuperAdmin - rest_password: Default: C1sco12345
-
get_healths
(headers=None, **query_parameters)[source]¶ 🚧 getHealths.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_performances
(headers=None, **query_parameters)[source]¶ 🚧 getPerformances.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
system_certificate¶
-
class
SystemCertificate
[source]¶ Identity Services Engine SystemCertificate API (version: 3.1.1).
Wraps the Identity Services Engine SystemCertificate API and exposes the API as native Python methods that return native Python objects.
System Certificate API provides the ability to create certificates like SAML, pxGrid.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
3.0
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Example Values
name
String
Yes
Resource Name
id
String
No
Resource UUID, mandatory for update
description
String
No
Support Bundle Status api
nodeId
String
Yes
NodeId of Cisco ISE application
ISE-01
localCertStub
List
Yes
Inputs for certificate creation
subjectStub
List
No
Subject data of certificate
commonName
String
No
Common Name
$FQDN$
organizationalUnitName
String
No
Organizational Unit Name
Cisco-SAMLCert
organizationName
String
No
Organizational Name
Cisco
localityName
String
No
Locality Name
City
stateOrProvinceName
String
No
State or Province Name
State
countryName
String
No
Country Name
Country
keyType
String
Yes
Key Type
RSA OR ECDSA
keyLength
String
Yes
Key Length
512 OR 1024 OR 2048 OR 4096
digest
String
Yes
Digest
SHA-256 OR SHA-384 OR SHA-512
expirationTTL
Integer
Yes
Expiration Time to Live (TTL)
2
selectedExpirationTTLUnit
String
Yes
Selected Expiration TTL Unit
days OR weeks OR months OR years
groupTagDD
String
No
Group Tag DD
add-group-tag
samlCertificate
String
No
SAML Certificate
on OR off
xgridCertificate
String
No
XGrid Certificate
on OR off
friendlyName
String
No
Friendly Name
Cisco
allowWildcardCerts
String
No
Allow Wildcard Certificates
on OR off
certificateSanDns
String
No
Certificate SAN DNS
cisco.com
certificateSanIp
String
No
Certificate SAN IP
IP-ADDRESS
certificateSanUri
String
No
Certificate SAN URI
URI
certificatePolicies
String
No
Certificate Profiles
certificate policies
-
create_system_certificate
(ers_local_cert_stub=None, node_id=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to create a system certificate.
- Parameters
ers_local_cert_stub (object) – Inputs for certificate creation, property of the request body.
node_id (string) – NodeId of Cisco ISE application, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(ers_local_cert_stub=None, node_id=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_system_certificate
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the system certificate.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
tacacs_command_sets¶
-
class
TacacsCommandSets
[source]¶ Identity Services Engine TACACSCommandSets API (version: 3.1.1).
Wraps the Identity Services Engine TACACSCommandSets API and exposes the API as native Python methods that return native Python objects.
TACACS Command Sets API allows the client to add, delete, update, search and perform actions on TACACS command sets.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.4
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Default Values
Example Values
name
String
Yes
Resource Name
DenyAllCommands
id
String
No
Resource UUID, mandatory for update
0cef7990-6120-11ea-bffb-7a82c56e81f0
description
String
No
Default Command Set
permitUnmatched
Boolean
No
false
commands
List
No
Holds list of Commands
commandList
List
No
Array of dictionaries describing various attributes with the properties: - grant (Enum. Allowed values: PERMIT, DENY, DENY_ALWAYS), - command (String), - arguments (String)
[ { “grant” : “PERMIT”, “command” : “create”, “arguments” : “value” } ]
-
get_tacacs_command_sets_by_name
(name, headers=None, **query_parameters)[source]¶ This API allows the client to get TACACS command sets by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_name
(name, headers=None, **query_parameters)[source]¶ Alias for get_tacacs_command_sets_by_name
-
get_tacacs_command_sets_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get TACACS command sets by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_tacacs_command_sets_by_id
-
update_tacacs_command_sets_by_id
(id, commands=None, description=None, name=None, permit_unmatched=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update TACACS command sets.
- Parameters
commands (object) – commands, property of the request body.
description (string) – description, property of the request body.
id (basestring) – id, property of the request body.
name (string) – name, property of the request body.
permit_unmatched (boolean) – permitUnmatched, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, commands=None, description=None, name=None, permit_unmatched=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_tacacs_command_sets_by_id
-
delete_tacacs_command_sets_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes TACACS command sets.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_tacacs_command_sets_by_id
-
get_tacacs_command_sets
(page=None, size=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the TACACS command sets.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_tacacs_command_sets
-
get_tacacs_command_sets_generator
(page=None, size=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the TACACS command sets.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_tacacs_command_sets_generator
-
create_tacacs_command_sets
(commands=None, description=None, name=None, permit_unmatched=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates TACACS command sets.
- Parameters
commands (object) – commands, property of the request body.
description (string) – description, property of the request body.
name (string) – name, property of the request body.
permit_unmatched (boolean) – permitUnmatched, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(commands=None, description=None, name=None, permit_unmatched=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_tacacs_command_sets
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the TACACS command sets.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
tacacs_external_servers¶
-
class
TacacsExternalServers
[source]¶ Identity Services Engine TACACSExternalServers API (version: 3.1.1).
Wraps the Identity Services Engine TACACSExternalServers API and exposes the API as native Python methods that return native Python objects.
TACACS External Servers API allows the client to add, delete, update, search and perform actions on TACACS external servers.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.4
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Default Values
Example Values
name
String
Yes
Resource Name
TacacsExternalServer1
id
String
No
Resource UUID, mandatory for update
1af3d6e2-cc3b-4603-b80f-6827768335ab
description
String
No
TacacsExternalServerForSDK
hostIP
String
Yes
The server IPV4 address
1.1.1.1
connectionPort
Integer
No
The port to connect the server
49
singleConnect
Boolean
No
Define the use of single connection
true
sharedSecret
String
Yes
The server shared secret
SharedSecret
timeout
Integer
No
The server timeout
20
-
get_tacacs_external_servers_by_name
(name, headers=None, **query_parameters)[source]¶ This API allows the client to get TACACS external servers by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_name
(name, headers=None, **query_parameters)[source]¶ Alias for get_tacacs_external_servers_by_name
-
get_tacacs_external_servers_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get TACACS external servers by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_tacacs_external_servers_by_id
-
update_tacacs_external_servers_by_id
(id, connection_port=None, description=None, host_ip=None, name=None, shared_secret=None, single_connect=None, timeout=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update TACACS external servers.
- Parameters
connection_port (integer) – The port to connect the server, property of the request body.
description (string) – description, property of the request body.
host_ip (string) – The server IPV4 address, property of the request body.
id (basestring) – id, property of the request body.
name (string) – name, property of the request body.
shared_secret (string) – The server shared secret, property of the request body.
single_connect (boolean) – Define the use of single connection, property of the request body.
timeout (integer) – The server timeout, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, connection_port=None, description=None, host_ip=None, name=None, shared_secret=None, single_connect=None, timeout=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_tacacs_external_servers_by_id
-
delete_tacacs_external_servers_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes TACACS external servers.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_tacacs_external_servers_by_id
-
get_tacacs_external_servers
(page=None, size=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the TACACS external servers.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_tacacs_external_servers
-
get_tacacs_external_servers_generator
(page=None, size=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the TACACS external servers.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_tacacs_external_servers_generator
-
create_tacacs_external_servers
(connection_port=None, description=None, host_ip=None, name=None, shared_secret=None, single_connect=None, timeout=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates TACACS external servers.
- Parameters
connection_port (integer) – The port to connect the server, property of the request body.
description (string) – description, property of the request body.
host_ip (string) – The server IPV4 address, property of the request body.
name (string) – name, property of the request body.
shared_secret (string) – The server shared secret, property of the request body.
single_connect (boolean) – Define the use of single connection, property of the request body.
timeout (integer) – The server timeout, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(connection_port=None, description=None, host_ip=None, name=None, shared_secret=None, single_connect=None, timeout=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_tacacs_external_servers
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the TACACS external servers.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
tacacs_profile¶
-
class
TacacsProfile
[source]¶ Identity Services Engine TACACSProfile API (version: 3.1.1).
Wraps the Identity Services Engine TACACSProfile API and exposes the API as native Python methods that return native Python objects.
TACACS Profile API allows the client to add, delete, update, search and perform actions on TACACS profile.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.4
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Example Values
name
String
Yes
Resource Name
Default Shell Profile
id
String
No
Resource UUID, mandatory for update
93d7ee70-92b5-11eb-a39d-96858bc78604
description
String
No
Default Shell Profile
sessionAttributes
List
No
Holds list of session attributes. View type for GUI is Shell by default
sessionAttributeList
List
No
Array of dictionaries describing various attributes with the properties: - type (Enum. Allowed values: MANDATORY, OPTIONAL), - name (String), - value (String)
[ { “type” : “MANDATORY”, “name” : “attr1”, “value” : “value” } ]
-
get_tacacs_profile_by_name
(name, headers=None, **query_parameters)[source]¶ This API allows the client to get a TACACS profile by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_name
(name, headers=None, **query_parameters)[source]¶ Alias for get_tacacs_profile_by_name
-
get_tacacs_profile_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get a TACACS profile by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_tacacs_profile_by_id
-
update_tacacs_profile_by_id
(id, description=None, name=None, session_attributes=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update a TACACS profile.
- Parameters
description (string) – description, property of the request body.
id (basestring) – id, property of the request body.
name (string) – name, property of the request body.
session_attributes (object) – Holds list of session attributes. View type for GUI is Shell by default, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, description=None, name=None, session_attributes=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_tacacs_profile_by_id
-
delete_tacacs_profile_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes a TACACS profile.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_tacacs_profile_by_id
-
get_tacacs_profile
(page=None, size=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the TACACS profiles.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_tacacs_profile
-
get_tacacs_profile_generator
(page=None, size=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the TACACS profiles.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_tacacs_profile_generator
-
create_tacacs_profile
(description=None, name=None, session_attributes=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates a TACACS profile.
- Parameters
description (string) – description, property of the request body.
name (string) – name, property of the request body.
session_attributes (object) – Holds list of session attributes. View type for GUI is Shell by default, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(description=None, name=None, session_attributes=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_tacacs_profile
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the TACACS profile.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
tacacs_server_sequence¶
-
class
TacacsServerSequence
[source]¶ Identity Services Engine TacacsServerSequence API (version: 3.1.1).
Wraps the Identity Services Engine TacacsServerSequence API and exposes the API as native Python methods that return native Python objects.
TACACS Server Sequence API aallows the client to add, delete, update, search and perform actions on TACACS server sequence.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.4
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Default Values
Example Values
name
String
Yes
Resource Name
TacacsServerSequence1
id
String
No
Resource UUID, mandatory for update
1af3d6e2-cc3b-4603-b80f-6827768335ab
description
String
No
TacacsServerSequenceForSDK
serverList
String
Yes
The names of Tacacs external servers separated by commas. The order of the names in the string is the order of servers that will be used during authentication
TacacsExternalServer1,TacacsExternalServer2
localAccounting
Boolean
No
false
remoteAccounting
Boolean
No
true
prefixStrip
Boolean
No
Define if a delimiter will be used for prefix strip
false
suffixStrip
Boolean
No
Define if a delimiter will be used for suffix strip
false
prefixDelimiter
String
No
The delimiter that will be used for prefix strip
suffixDelimiter
String
No
The delimiter that will be used for suffix strip
@
-
get_tacacs_server_sequence_by_name
(name, headers=None, **query_parameters)[source]¶ This API allows the client to get a TACACS server sequence by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_name
(name, headers=None, **query_parameters)[source]¶ Alias for get_tacacs_server_sequence_by_name
-
get_tacacs_server_sequence_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get a TACACS server sequence by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_tacacs_server_sequence_by_id
-
update_tacacs_server_sequence_by_id
(id, description=None, local_accounting=None, name=None, prefix_delimiter=None, prefix_strip=None, remote_accounting=None, server_list=None, suffix_delimiter=None, suffix_strip=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update a TACACS server sequence.
- Parameters
description (string) – description, property of the request body.
id (basestring) – id, property of the request body.
local_accounting (boolean) – localAccounting, property of the request body.
name (string) – name, property of the request body.
prefix_delimiter (string) – The delimiter that will be used for prefix strip, property of the request body.
prefix_strip (boolean) – Define if a delimiter will be used for prefix strip, property of the request body.
remote_accounting (boolean) – remoteAccounting, property of the request body.
server_list (string) – The names of Tacacs external servers separated by commas. The order of the names in the string is the order of servers that will be used during authentication, property of the request body.
suffix_delimiter (string) – The delimiter that will be used for suffix strip, property of the request body.
suffix_strip (boolean) – Define if a delimiter will be used for suffix strip, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, description=None, local_accounting=None, name=None, prefix_delimiter=None, prefix_strip=None, remote_accounting=None, server_list=None, suffix_delimiter=None, suffix_strip=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_tacacs_server_sequence_by_id
-
delete_tacacs_server_sequence_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes a TACACS server sequence.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_tacacs_server_sequence_by_id
-
get_tacacs_server_sequence
(page=None, size=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the TACACS server sequences.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_tacacs_server_sequence
-
get_tacacs_server_sequence_generator
(page=None, size=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the TACACS server sequences.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_tacacs_server_sequence_generator
-
create_tacacs_server_sequence
(description=None, local_accounting=None, name=None, prefix_delimiter=None, prefix_strip=None, remote_accounting=None, server_list=None, suffix_delimiter=None, suffix_strip=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates a TACACS server sequence.
- Parameters
description (string) – description, property of the request body.
local_accounting (boolean) – localAccounting, property of the request body.
name (string) – name, property of the request body.
prefix_delimiter (string) – The delimiter that will be used for prefix strip, property of the request body.
prefix_strip (boolean) – Define if a delimiter will be used for prefix strip, property of the request body.
remote_accounting (boolean) – remoteAccounting, property of the request body.
server_list (string) – The names of Tacacs external servers separated by commas. The order of the names in the string is the order of servers that will be used during authentication, property of the request body.
suffix_delimiter (string) – The delimiter that will be used for suffix strip, property of the request body.
suffix_strip (boolean) – Define if a delimiter will be used for suffix strip, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(description=None, local_accounting=None, name=None, prefix_delimiter=None, prefix_strip=None, remote_accounting=None, server_list=None, suffix_delimiter=None, suffix_strip=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_tacacs_server_sequence
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the TACACS server sequence.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
telemetry_information¶
-
class
TelemetryInformation
[source]¶ Identity Services Engine TelemetryInformation API (version: 3.1.1).
Wraps the Identity Services Engine TelemetryInformation API and exposes the API as native Python methods that return native Python objects.
Telemetry Information API allows clients to get telemetry configuration information.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
3.0
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Example Values
name
String
Yes
Resource Name
id
String
No
Resource UUID, mandatory for update
ed7176fb-3faf-4060-845e-d5fa5236bd6e
description
String
No
status
String
No
SCHEnable
deploymentId
String
No
ed7176fb-3faf-4060-845e-d5fa5236bd6e
udiSN
String
No
CH2MKIEGBGO
-
get_telemetry_info_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get telemetry information by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_telemetry_info_by_id
-
get_telemetry_information
(filter=None, filter_type=None, page=None, size=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the telemetry information. Filter: [deploymentId] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 .
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_telemetry_information
-
get_telemetry_information_generator
(filter=None, filter_type=None, page=None, size=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the telemetry information. Filter: [deploymentId] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 .
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_telemetry_information_generator
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the telemetry information.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
trust_sec_configuration¶
-
class
TrustSecConfiguration
[source]¶ Identity Services Engine TrustSec Configuration API (version: 3.1.1).
Wraps the Identity Services Engine TrustSec Configuration API and exposes the API as native Python methods that return native Python objects.
# Cisco ISE 3.0 pxGrid REST APIs
## License [Cisco Sample Code License](https://developer.cisco.com/site/license/cisco-sample-code-license/)
## Status These are the status icons for the requests so far. - ⌗ : must create resources to test - 🚧 : incomplete | untested - 🛑 : unsupported | bug
## Environment Variables This collection uses environment variables in scripts in the Tests tab to store data (id, name, portalId, etc.) between requests. This allows you to GET or POST then immediately GET {id} on a resource. Using No Environment will cause this convenience functionality to fail so be sure to choose one.
## Collection Variables This collection includes some default variables that you will want to update or override with environment variables for your ISE deployment. Specifically, you will want to set: - ise_pxg: the ISE PAN node name or IP address. Default: ise.securitydemo.net - rest_username: the username for ERS API access. Must be a member of SuperAdmin, ERSAdmin or ERSOperator groups. Default: admin which is the ISE SuperAdmin - rest_password: Default: C1sco12345
-
get_security_groups
(headers=None, **query_parameters)[source]¶ 🚧 getSecurityGroups.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(headers=None, **query_parameters)[source]¶ Alias for get_security_groups
-
get_security_group_acls
(headers=None, **query_parameters)[source]¶ 🚧 getSecurityGroupAcls.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_egress_policies
(headers=None, **query_parameters)[source]¶ 🚧 getEgressPolicies.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_egress_matrices
(headers=None, **query_parameters)[source]¶ 🚧 getEgressMatrices.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
trust_sec_sxp¶
-
class
TrustSecSxp
[source]¶ Identity Services Engine TrustSec SXP API (version: 3.1.1).
Wraps the Identity Services Engine TrustSec SXP API and exposes the API as native Python methods that return native Python objects.
# Cisco ISE 3.0 pxGrid REST APIs
## License [Cisco Sample Code License](https://developer.cisco.com/site/license/cisco-sample-code-license/)
## Status These are the status icons for the requests so far. - ⌗ : must create resources to test - 🚧 : incomplete | untested - 🛑 : unsupported | bug
## Environment Variables This collection uses environment variables in scripts in the Tests tab to store data (id, name, portalId, etc.) between requests. This allows you to GET or POST then immediately GET {id} on a resource. Using No Environment will cause this convenience functionality to fail so be sure to choose one.
## Collection Variables This collection includes some default variables that you will want to update or override with environment variables for your ISE deployment. Specifically, you will want to set: - ise_pxg: the ISE PAN node name or IP address. Default: ise.securitydemo.net - rest_username: the username for ERS API access. Must be a member of SuperAdmin, ERSAdmin or ERSOperator groups. Default: admin which is the ISE SuperAdmin - rest_password: Default: C1sco12345
-
get_bindings
(headers=None, **query_parameters)[source]¶ 🚧 getBindings.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
version_and_patch¶
-
class
VersionAndPatch
[source]¶ Identity Services Engine VersionAndPatch API (version: 3.1.1).
Wraps the Identity Services Engine VersionAndPatch API and exposes the API as native Python methods that return native Python objects.
Version and Patch API is used to provide the Cisco ISE version on which the Cisco ISE cluster is running, and a comma-separated list of the patches that are installed. The highest numbered patch is the patch that the cluster in running on.
-
get_ise_version_and_patch
(headers=None, **query_parameters)[source]¶ This API allows the client to get Cisco ISE version and patch information.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(headers=None, **query_parameters)[source]¶ Alias for get_ise_version_and_patch
-
version_info¶
-
class
VersionInfo
[source]¶ Identity Services Engine VersionInfo API (version: 3.1.1).
Wraps the Identity Services Engine VersionInfo API and exposes the API as native Python methods that return native Python objects.
Version and Patch API is used to provide the Cisco ISE version on which the Cisco ISE cluster is running, and a comma-separated list of the patches that are installed. The highest numbered patch is the patch that the cluster in running on.
-
get_version_info
(resource, headers=None, **query_parameters)[source]¶ Get all VersionInfo.
- Parameters
resource (basestring) – resource path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
endpoint¶
-
class
Endpoint
[source]¶ Identity Services Engine endpoint API (version: 3.1.1).
Wraps the Identity Services Engine endpoint API and exposes the API as native Python methods that return native Python objects.
Endpoint API allows the client to add, delete, update, search, register and de-register endpoints. Please note that each API description shows whether the API is supported in bulk operation. The Bulk section is showing only ‘create’ bulk operation however, all other operation which are bulk supported can be used in same way.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
Revision Modification
Attribute
Description
0
1.0
1.3
Initial Cisco ISE Version
1
1.1
2.1
Cisco ISE 2.1 model changes
customAttributes
Added custom attibutes for the user to include custom attributes when adding endpoints to Cisco ISE
2
1.2
2.2
Cisco ISE 2.2 model changes
apiAdded
Added custom operation to get list of rejected endpoints: ‘/getrejectedendpoints’
apiAdded
Added custom operation to release rejected endpoint: ‘{id}/releaserejectedendpoint’
Resource Definition
Attribute
Type
Required
Description
Example Values
name
String
Yes
Resource Name
11:22:33:44:55:66
id
String
No
Resource UUID, mandatory for update
172f8270-8f4f-11eb-b4a8-9eb04987ed29
description
String
No
MyEndpoint
customAttributes
Map
No
Key value map
{“key1” : “value1”}
groupId
String
Yes
aa13bb40-8bff-11e6-996c-525400b48521
identityStore
String
No
identityStore
identityStoreId
String
No
identityStoreId
mac
String
Yes
11:22:33:44:55:66
portalUser
String
No
portalUser
profileId
String
No
profileId
staticGroupAssignment
Boolean
Yes
true
staticProfileAssignment
Boolean
Yes
false
-
release_rejected_endpoint
(id, headers=None, **query_parameters)[source]¶ This API allows the client to release a rejected endpoint.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
release_rejected
(id, headers=None, **query_parameters)[source]¶ Alias for release_rejected_endpoint
-
deregister_endpoint
(id, headers=None, **query_parameters)[source]¶ This API allows the client to de-register an endpoint.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
deregister
(id, headers=None, **query_parameters)[source]¶ Alias for deregister_endpoint
-
get_rejected_endpoints
(headers=None, **query_parameters)[source]¶ This API allows the client to get the rejected endpoints.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_rejected
(headers=None, **query_parameters)[source]¶ Alias for get_rejected_endpoints
-
get_endpoint_by_name
(name, headers=None, **query_parameters)[source]¶ This API allows the client to get an endpoint by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_name
(name, headers=None, **query_parameters)[source]¶ Alias for get_endpoint_by_name
-
get_endpoint_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get an endpoint by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_endpoint_by_id
-
update_endpoint_by_id
(id, custom_attributes=None, description=None, group_id=None, identity_store=None, identity_store_id=None, mac=None, mdm_attributes=None, name=None, portal_user=None, profile_id=None, static_group_assignment=None, static_profile_assignment=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to update an endpoint.
- Parameters
custom_attributes (object) – customAttributes, property of the request body.
description (string) – description, property of the request body.
group_id (string) – groupId, property of the request body.
id (basestring) – id, property of the request body.
identity_store (string) – identityStore, property of the request body.
identity_store_id (string) – identityStoreId, property of the request body.
mac (string) – mac, property of the request body.
mdm_attributes (object) – mdmAttributes, property of the request body.
name (string) – name, property of the request body.
portal_user (string) – portalUser, property of the request body.
profile_id (string) – profileId, property of the request body.
static_group_assignment (boolean) – staticGroupAssignment, property of the request body.
static_profile_assignment (boolean) – staticProfileAssignment, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, custom_attributes=None, description=None, group_id=None, identity_store=None, identity_store_id=None, mac=None, mdm_attributes=None, name=None, portal_user=None, profile_id=None, static_group_assignment=None, static_profile_assignment=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_endpoint_by_id
-
delete_endpoint_by_id
(id, headers=None, **query_parameters)[source]¶ This API deletes an endpoint.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_endpoint_by_id
-
register_endpoint
(custom_attributes=None, description=None, group_id=None, id=None, identity_store=None, identity_store_id=None, mac=None, mdm_attributes=None, name=None, portal_user=None, profile_id=None, static_group_assignment=None, static_profile_assignment=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to register an endpoint.
- Parameters
custom_attributes (object) – customAttributes, property of the request body.
description (string) – description, property of the request body.
group_id (string) – groupId, property of the request body.
id (string) – id, property of the request body.
identity_store (string) – identityStore, property of the request body.
identity_store_id (string) – identityStoreId, property of the request body.
mac (string) – mac, property of the request body.
mdm_attributes (object) – mdmAttributes, property of the request body.
name (string) – name, property of the request body.
portal_user (string) – portalUser, property of the request body.
profile_id (string) – profileId, property of the request body.
static_group_assignment (boolean) – staticGroupAssignment, property of the request body.
static_profile_assignment (boolean) – staticProfileAssignment, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
register
(custom_attributes=None, description=None, group_id=None, id=None, identity_store=None, identity_store_id=None, mac=None, mdm_attributes=None, name=None, portal_user=None, profile_id=None, static_group_assignment=None, static_profile_assignment=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for register_endpoint
-
get_endpoints
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the endpoints. Filter: Filters can be used to filter out Endpoints based on a set of attributes. This API currently provides the following filters: [logicalProfileName, portalUser, staticProfileAssignment, profileId, profile, groupId, staticGroupAssignment, mac] Example 1: The logicalProfileName filter can be used to get Enpoints that belong to a specific Logical Profile. The supported operator for logicalProfileNamefilter is EQ (equal to). The syntax to invoke the API with this filter: /ers/config/endpoint?filter={filter name}.{operator}.{logical profile name} Example: https://{ise-ip}:9060/ers/config/endpoint?filter=logical ProfileName.EQ.LP_Apple Example 2: To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_endpoints
-
get_endpoints_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the endpoints. Filter: Filters can be used to filter out Endpoints based on a set of attributes. This API currently provides the following filters: [logicalProfileName, portalUser, staticProfileAssignment, profileId, profile, groupId, staticGroupAssignment, mac] Example 1: The logicalProfileName filter can be used to get Enpoints that belong to a specific Logical Profile. The supported operator for logicalProfileNamefilter is EQ (equal to). The syntax to invoke the API with this filter: /ers/config/endpoint?filter={filter name}.{operator}.{logical profile name} Example: https://{ise-ip}:9060/ers/config/endpoint?filter=logical ProfileName.EQ.LP_Apple Example 2: To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_endpoints_generator
-
create_endpoint
(custom_attributes=None, description=None, group_id=None, identity_store=None, identity_store_id=None, mac=None, mdm_attributes=None, name=None, portal_user=None, profile_id=None, static_group_assignment=None, static_profile_assignment=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API creates an endpoint.
- Parameters
custom_attributes (object) – customAttributes, property of the request body.
description (string) – description, property of the request body.
group_id (string) – groupId, property of the request body.
identity_store (string) – identityStore, property of the request body.
identity_store_id (string) – identityStoreId, property of the request body.
mac (string) – mac, property of the request body.
mdm_attributes (object) – mdmAttributes, property of the request body.
name (string) – name, property of the request body.
portal_user (string) – portalUser, property of the request body.
profile_id (string) – profileId, property of the request body.
static_group_assignment (boolean) – staticGroupAssignment, property of the request body.
static_profile_assignment (boolean) – staticProfileAssignment, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(custom_attributes=None, description=None, group_id=None, identity_store=None, identity_store_id=None, mac=None, mdm_attributes=None, name=None, portal_user=None, profile_id=None, static_group_assignment=None, static_profile_assignment=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_endpoint
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the endpoint.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
bulk_request_for_endpoint
(operation_type=None, resource_media_type=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ This API allows the client to submit the bulk request.
- Parameters
operation_type (string) – operationType, property of the request body.
resource_media_type (string) – resourceMediaType, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
bulk_request
(operation_type=None, resource_media_type=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for bulk_request_for_endpoint
-
monitor_bulk_status_endpoint
(bulkid, headers=None, **query_parameters)[source]¶ This API allows the client to monitor the bulk request.
- Parameters
bulkid (basestring) – bulkid path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
monitor_bulk_status
(bulkid, headers=None, **query_parameters)[source]¶ Alias for monitor_bulk_status_endpoint
-
nbar_app¶
-
class
NbarApp
[source]¶ Identity Services Engine nbarApp API (version: 3.1.1).
Wraps the Identity Services Engine nbarApp API and exposes the API as native Python methods that return native Python objects.
-
get_nbar_apps
(filter=None, filter_type=None, page=None, size=None, sort=None, sort_by=None, headers=None, **query_parameters)[source]¶ Get all NBAR Applications.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sort (basestring) – sort query parameter. sort type asc or desc.
sort_by (basestring) – sortBy query parameter. sort column by which objects needs to be sorted.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. OPERATOR DESCRIPTION EQ Equals NEQ Not Equals GT Greater Than LT Less Then STARTSW Starts With NSTARTSW Not Starts With ENDSW Ends With NENDSW Not Ends With CONTAINS Contains NCONTAINS Not Contains .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sort=None, sort_by=None, headers=None, **query_parameters)[source]¶ Alias for get_nbar_apps
-
get_nbar_apps_generator
(filter=None, filter_type=None, page=None, size=None, sort=None, sort_by=None, headers=None, **query_parameters)[source]¶ Get all NBAR Applications.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sort (basestring) – sort query parameter. sort type asc or desc.
sort_by (basestring) – sortBy query parameter. sort column by which objects needs to be sorted.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. OPERATOR DESCRIPTION EQ Equals NEQ Not Equals GT Greater Than LT Less Then STARTSW Starts With NSTARTSW Not Starts With ENDSW Ends With NENDSW Not Ends With CONTAINS Contains NCONTAINS Not Contains .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sort=None, sort_by=None, headers=None, **query_parameters)[source]¶ Alias for get_nbar_apps_generator
-
create_nbar_app
(description=None, id=None, name=None, network_identities=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Create NBAR application.
- Parameters
description (string) – description, property of the request body.
id (string) – id, property of the request body.
name (string) – name, property of the request body.
network_identities (list) – Array of NIs, property of the request body (list of objects).
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(description=None, id=None, name=None, network_identities=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_nbar_app
-
get_nbar_app_by_id
(id, headers=None, **query_parameters)[source]¶ Get NBAR Application by id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_nbar_app_by_id
-
update_nbar_app_by_id
(id, description=None, name=None, network_identities=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Update NBAR Application.
- Parameters
description (string) – description, property of the request body.
id (basestring) – id, property of the request body.
name (string) – name, property of the request body.
network_identities (list) – Array of NIs, property of the request body (list of objects).
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, description=None, name=None, network_identities=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_nbar_app_by_id
-
delete_nbar_app_by_id
(id, headers=None, **query_parameters)[source]¶ Delete NBAR Application.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_nbar_app_by_id
-
portal¶
-
class
Portal
[source]¶ Identity Services Engine portal API (version: 3.1.1).
Wraps the Identity Services Engine portal API and exposes the API as native Python methods that return native Python objects.
Portal API allows the client to search profiles.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
1.2
Initial Cisco ISE Version
1
2.0
1.3
Introducing new schema - not supporting 1.0 anymore
Resource Definition
Attribute
Type
Required
Description
Example Values
name
String
Yes
Resource Name
ISE Portal (default)
id
String
No
Resource UUID, mandatory for update
bc5524ea-b1e5-47ed-a907-5304821da916
description
String
No
ISE Portal for saml based feature purpose
portalType
String
No
GUEST
-
get_portal_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get a portal by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_portal_by_id
-
get_portals
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the portals. Filter: [name, description] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_portals
-
get_portals_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the portals. Filter: [name, description] To search resources by using toDate column,follow the format: DD-MON-YY (Example:13-SEP-18) Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13 Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18 Sorting: [name, description].
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶ Alias for get_portals_generator
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information realted to the portal.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
proxy¶
-
class
Proxy
[source]¶ Identity Services Engine proxy API (version: 3.1.1).
Wraps the Identity Services Engine proxy API and exposes the API as native Python methods that return native Python objects.
-
get_proxy_connection
(headers=None, **query_parameters)[source]¶ The following functionalities are impacted by the proxy settings: Partner Mobile Management Endpoint Profiler Feed Service Update Endpoint Posture Update Endpoint Posture Agent Resources Download CRL (Certificate Revocation List) Download SMS Message Transmission Social Login Rest Auth Service Azure AD pxGrid Cloud .
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_proxy_connection
(bypass_hosts=None, fqdn=None, password=None, password_required=None, port=None, user_name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ The following functionalities are impacted by the proxy settings: Partner Mobile Management Endpoint Profiler Feed Service Update Endpoint Posture Update Endpoint Posture Agent Resources Download CRL (Certificate Revocation List) Download SMS Message Transmission Social Login Rest Auth Service Azure AD pxGrid Cloud .
- Parameters
bypass_hosts (string) – Bypass hosts for the proxy connection, property of the request body.
fqdn (string) – proxy IP address or DNS-resolvable host name, property of the request body.
password (string) – Password for the proxy connection, property of the request body.
password_required (boolean) – Indicates whether password configuration is required for Proxy., property of the request body.
port (integer) – Port for proxy connection. should be between 1 and 65535, property of the request body.
user_name (string) – User name for the proxy connection, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
px_grid_node¶
-
class
PxGridNode
[source]¶ Identity Services Engine pxGridNode API (version: 3.1.1).
Wraps the Identity Services Engine pxGridNode API and exposes the API as native Python methods that return native Python objects.
pxGrid Node API allows the client to retrieve pxGrid information, delete an existing pxGrid node, and approve new pxGrid nodes. Note: From Cisco ISE Release 3.1, all pxGrid connections must be based on pxGrid 2.0. pxGrid 1.0-based (XMPP-based) integrations will cease to work on Cisco ISE from Release 3.1 onwards. pxGrid Version 2.0, which is based on WebSockets, was introduced in Cisco ISE Release 2.4. We recommend that you plan and upgrade your other systems to pxGrid 2.0-compliant versions in order to prevent potential disruptions, if any, to integrations.Revision History
Revision #
Resource Version
Cisco ISE Version
Description
0
1.0
2.4
Initial Cisco ISE Version
Resource Definition
Attribute
Type
Required
Description
Example Values
name
String
Yes
Resource Name
ers-sample-client
id
String
No
Resource UUID, mandatory for update
ab6deded-fcc2-47ff-8577-0014737c8fcf
description
String
No
ERS sample client
status
String
No
Online (XMPP)
authMethod
String
No
Certificate
groups
String
No
pxGrid Characterization
Session data Consumption over pxGrid
On a 35 node Cisco ISE deployment with a dedicated primary Policy Administration node (PAN), dedicated secondary PAN, dedicated primary Monitoring and Troubleshooting node (MnT node), dedicated secondary MnT, dedicated pxGrid node and 30 heterogeneous Policy Service node (PSN) platforms, there was no delay observed in consuming session data with the following parameters as shown in the table below:
RADIUS Traffic
Total number of sessions in the deployment
Number of pxGrid clients (subscribers to the session topic)
pxGrid client’s delay in consuming session data
Upto 500 transactions per second (TPS)
~2 million
50
No delay
Bulk download time taken
On a 35 node Cisco ISE deployment with a dedicated primary PAN, dedicated secondary PAN, dedicated primary MnT, dedicated secondary MnT, dedicated pxGrid node and 30 heterogeneous PSN Platforms, the bulk download time for all the pxGrid clients is shown in the table below:
Total number of sessions in the deployment
Number of pxGrid clients (subscribers to the session topic)
Time taken for bulk download
2 million
50
~17 minutes
Note: From Cisco ISE Release 3.1, we can use either pxgridnode or pxgridNode in the URL.-
approve_px_grid_node
(name, headers=None, **query_parameters)[source]¶ This API allows the client to approve a pxGrid node. Only pending pxGrid nodes can be approved.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
approve
(name, headers=None, **query_parameters)[source]¶ Alias for approve_px_grid_node
-
get_px_grid_node_by_name
(name, headers=None, **query_parameters)[source]¶ This API allows the client to get a pxGrid node by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_name
(name, headers=None, **query_parameters)[source]¶ Alias for get_px_grid_node_by_name
-
delete_px_grid_node_by_name
(name, headers=None, **query_parameters)[source]¶ This API deletes a pxGrid node by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_name
(name, headers=None, **query_parameters)[source]¶ Alias for delete_px_grid_node_by_name
-
get_px_grid_node_by_id
(id, headers=None, **query_parameters)[source]¶ This API allows the client to get a pxGrid node by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_px_grid_node_by_id
-
get_px_grid_node
(page=None, size=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the npxGrid nodes.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_px_grid_node
-
get_px_grid_node_generator
(page=None, size=None, headers=None, **query_parameters)[source]¶ This API allows the client to get all the npxGrid nodes.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(page=None, size=None, headers=None, **query_parameters)[source]¶ Alias for get_px_grid_node_generator
-
get_version
(headers=None, **query_parameters)[source]¶ This API helps to retrieve the version information related to the pxGrid node.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
sg_vn_mapping¶
-
class
SgVnMapping
[source]¶ Identity Services Engine sgVnMapping API (version: 3.1.1).
Wraps the Identity Services Engine sgVnMapping API and exposes the API as native Python methods that return native Python objects.
-
get_sg_vn_mappings
(filter=None, filter_type=None, page=None, size=None, sort=None, sort_by=None, headers=None, **query_parameters)[source]¶ Get all Security Group and Virtual Network mappings.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sort (basestring) – sort query parameter. sort type asc or desc.
sort_by (basestring) – sortBy query parameter. sort column by which objects needs to be sorted.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. OPERATOR DESCRIPTION EQ Equals NEQ Not Equals GT Greater Than LT Less Then STARTSW Starts With NSTARTSW Not Starts With ENDSW Ends With NENDSW Not Ends With CONTAINS Contains NCONTAINS Not Contains .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sort=None, sort_by=None, headers=None, **query_parameters)[source]¶ Alias for get_sg_vn_mappings
-
get_sg_vn_mappings_generator
(filter=None, filter_type=None, page=None, size=None, sort=None, sort_by=None, headers=None, **query_parameters)[source]¶ Get all Security Group and Virtual Network mappings.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sort (basestring) – sort query parameter. sort type asc or desc.
sort_by (basestring) – sortBy query parameter. sort column by which objects needs to be sorted.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. OPERATOR DESCRIPTION EQ Equals NEQ Not Equals GT Greater Than LT Less Then STARTSW Starts With NSTARTSW Not Starts With ENDSW Ends With NENDSW Not Ends With CONTAINS Contains NCONTAINS Not Contains .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sort=None, sort_by=None, headers=None, **query_parameters)[source]¶ Alias for get_sg_vn_mappings_generator
-
create_sg_vn_mapping
(id=None, last_update=None, sg_name=None, sgt_id=None, vn_id=None, vn_name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Create Security Group and Virtual Network mapping.
- Parameters
id (string) – Identifier of the SG-VN mapping, property of the request body.
last_update (string) – Timestamp for the last update of the SG-VN mapping, property of the request body.
sg_name (string) – Name of the associated Security Group to be used for identity if id is not provided, property of the request body.
sgt_id (string) – Identifier of the associated Security Group which is required unless its name is provided, property of the request body.
vn_id (string) – Identifier for the associated Virtual Network which is required unless its name is provided, property of the request body.
vn_name (string) – Name of the associated Virtual Network to be used for identity if id is not provided, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(id=None, last_update=None, sg_name=None, sgt_id=None, vn_id=None, vn_name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_sg_vn_mapping
-
bulk_create_sg_vn_mappings
(headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Create SG-VN Mappings in bulk.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (list) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
bulk_request_create
(headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for bulk_create_sg_vn_mappings
-
bulk_delete_sg_vn_mappings
(headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Delete SG-VN Mappings in bulk.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (list) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
bulk_request_delete
(headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for bulk_delete_sg_vn_mappings
-
bulk_update_sg_vn_mappings
(headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Update SG-VN Mappings in bulk.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (list) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
bulk_request_update
(headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for bulk_update_sg_vn_mappings
-
get_sg_vn_mapping_by_id
(id, headers=None, **query_parameters)[source]¶ Get Security Group and Virtual Network mapping by id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_sg_vn_mapping_by_id
-
update_sg_vn_mapping_by_id
(id, last_update=None, sg_name=None, sgt_id=None, vn_id=None, vn_name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Update Security Group and Virtual Network mapping.
- Parameters
id (basestring) – Identifier of the SG-VN mapping, property of the request body.
last_update (string) – Timestamp for the last update of the SG-VN mapping, property of the request body.
sg_name (string) – Name of the associated Security Group to be used for identity if id is not provided, property of the request body.
sgt_id (string) – Identifier of the associated Security Group which is required unless its name is provided, property of the request body.
vn_id (string) – Identifier for the associated Virtual Network which is required unless its name is provided, property of the request body.
vn_name (string) – Name of the associated Virtual Network to be used for identity if id is not provided, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, last_update=None, sg_name=None, sgt_id=None, vn_id=None, vn_name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_sg_vn_mapping_by_id
-
delete_sg_vn_mapping_by_id
(id, headers=None, **query_parameters)[source]¶ Delete Security Group and Virtual Network mapping.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_sg_vn_mapping_by_id
-
tasks¶
-
class
Tasks
[source]¶ Identity Services Engine tasks API (version: 3.1.1).
Wraps the Identity Services Engine tasks API and exposes the API as native Python methods that return native Python objects.
-
get_task_status
(headers=None, **query_parameters)[source]¶ get all task status.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(list): A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_task_status_by_id
(task_id, headers=None, **query_parameters)[source]¶ Monitor task status.
- Parameters
task_id (basestring) – taskId path parameter. The id of the task executed before.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
telemetry¶
-
class
Telemetry
[source]¶ Identity Services Engine telemetry API (version: 3.1.1).
Wraps the Identity Services Engine telemetry API and exposes the API as native Python methods that return native Python objects.
-
get_transport_gateway
(headers=None, **query_parameters)[source]¶ Transport Gateway acts a proxy for the communication between the ISE servers in your network and the Telemetry servers in case of air-gapped network.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_transport_gateway
(enable_transport_gateway=None, url=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Transport Gateway acts a proxy for the communication between the ISE servers in your network and the Telemetry servers in case of air-gapped network.
- Parameters
enable_transport_gateway (boolean) – Indicates whether transport gateway is enabled or not., property of the request body.
url (string) – URL of transport gateway, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
virtual_network¶
-
class
VirtualNetwork
[source]¶ Identity Services Engine virtualNetwork API (version: 3.1.1).
Wraps the Identity Services Engine virtualNetwork API and exposes the API as native Python methods that return native Python objects.
-
get_virtual_networks
(filter=None, filter_type=None, page=None, size=None, sort=None, sort_by=None, headers=None, **query_parameters)[source]¶ Get all Virtual Networks.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sort (basestring) – sort query parameter. sort type asc or desc.
sort_by (basestring) – sortBy query parameter. sort column by which objects needs to be sorted.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. OPERATOR DESCRIPTION EQ Equals NEQ Not Equals GT Greater Than LT Less Then STARTSW Starts With NSTARTSW Not Starts With ENDSW Ends With NENDSW Not Ends With CONTAINS Contains NCONTAINS Not Contains .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sort=None, sort_by=None, headers=None, **query_parameters)[source]¶ Alias for get_virtual_networks
-
get_virtual_networks_generator
(filter=None, filter_type=None, page=None, size=None, sort=None, sort_by=None, headers=None, **query_parameters)[source]¶ Get all Virtual Networks.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sort (basestring) – sort query parameter. sort type asc or desc.
sort_by (basestring) – sortBy query parameter. sort column by which objects needs to be sorted.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. OPERATOR DESCRIPTION EQ Equals NEQ Not Equals GT Greater Than LT Less Then STARTSW Starts With NSTARTSW Not Starts With ENDSW Ends With NENDSW Not Ends With CONTAINS Contains NCONTAINS Not Contains .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sort=None, sort_by=None, headers=None, **query_parameters)[source]¶ Alias for get_virtual_networks_generator
-
create_virtual_network
(additional_attributes=None, id=None, last_update=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Create Virtual Network.
- Parameters
additional_attributes (string) – JSON String of additional attributes for the Virtual Network, property of the request body.
id (string) – Identifier of the Virtual Network, property of the request body.
last_update (string) – Timestamp for the last update of the Virtual Network, property of the request body.
name (string) – Name of the Virtual Network, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(additional_attributes=None, id=None, last_update=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_virtual_network
-
bulk_create_virtual_networks
(headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Create Virtual Network in bulk.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (list) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
bulk_request_create
(headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for bulk_create_virtual_networks
-
bulk_delete_virtual_networks
(headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Delete Virtual Network in bulk.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (list) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
bulk_request_delete
(headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for bulk_delete_virtual_networks
-
bulk_update_virtual_networks
(headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Update Virtual Network in bulk.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (list) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
bulk_request_update
(headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for bulk_update_virtual_networks
-
get_virtual_network_by_id
(id, headers=None, **query_parameters)[source]¶ Get Virtual Network by id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_virtual_network_by_id
-
update_virtual_network_by_id
(id, additional_attributes=None, last_update=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Update Virtual Network.
- Parameters
additional_attributes (string) – JSON String of additional attributes for the Virtual Network, property of the request body.
id (basestring) – Identifier of the Virtual Network, property of the request body.
last_update (string) – Timestamp for the last update of the Virtual Network, property of the request body.
name (string) – Name of the Virtual Network, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
update_by_id
(id, additional_attributes=None, last_update=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for update_virtual_network_by_id
-
delete_virtual_network_by_id
(id, headers=None, **query_parameters)[source]¶ Delete Virtual Network.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for delete_virtual_network_by_id
-
vn_vlan_mapping¶
-
class
VnVlanMapping
[source]¶ Identity Services Engine vnVlanMapping API (version: 3.1.1).
Wraps the Identity Services Engine vnVlanMapping API and exposes the API as native Python methods that return native Python objects.
-
get_vn_vlan_mappings
(filter=None, filter_type=None, page=None, size=None, sort=None, sort_by=None, headers=None, **query_parameters)[source]¶ Get all VN-Vlan Mappings.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sort (basestring) – sort query parameter. sort type asc or desc.
sort_by (basestring) – sortBy query parameter. sort column by which objects needs to be sorted.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. OPERATOR DESCRIPTION EQ Equals NEQ Not Equals GT Greater Than LT Less Then STARTSW Starts With NSTARTSW Not Starts With ENDSW Ends With NENDSW Not Ends With CONTAINS Contains NCONTAINS Not Contains .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all
(filter=None, filter_type=None, page=None, size=None, sort=None, sort_by=None, headers=None, **query_parameters)[source]¶ Alias for get_vn_vlan_mappings
-
get_vn_vlan_mappings_generator
(filter=None, filter_type=None, page=None, size=None, sort=None, sort_by=None, headers=None, **query_parameters)[source]¶ Get all VN-Vlan Mappings.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sort (basestring) – sort query parameter. sort type asc or desc.
sort_by (basestring) – sortBy query parameter. sort column by which objects needs to be sorted.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. OPERATOR DESCRIPTION EQ Equals NEQ Not Equals GT Greater Than LT Less Then STARTSW Starts With NSTARTSW Not Starts With ENDSW Ends With NENDSW Not Ends With CONTAINS Contains NCONTAINS Not Contains .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
A generator object containing the following object.
RestResponse: REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_all_generator
(filter=None, filter_type=None, page=None, size=None, sort=None, sort_by=None, headers=None, **query_parameters)[source]¶ Alias for get_vn_vlan_mappings_generator
-
create_vn_vlan_mapping
(id=None, is_data=None, is_default_vlan=None, last_update=None, max_value=None, name=None, vn_id=None, vn_name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Create VN-Vlan Mapping.
- Parameters
id (string) – Identifier of the VN-Vlan Mapping, property of the request body.
is_data (boolean) – Flag which indicates whether the Vlan is data or voice type, property of the request body.
is_default_vlan (boolean) – Flag which indicates if the Vlan is default, property of the request body.
last_update (string) – Timestamp for the last update of the VN-Vlan Mapping, property of the request body.
max_value (integer) – Max value, property of the request body.
name (string) – Name of the Vlan, property of the request body.
vn_id (string) – Identifier for the associated Virtual Network which is required unless its name is provided, property of the request body.
vn_name (string) – Name of the associated Virtual Network to be used for identity if id is not provided, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
create
(id=None, is_data=None, is_default_vlan=None, last_update=None, max_value=None, name=None, vn_id=None, vn_name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for create_vn_vlan_mapping
-
bulk_create_vn_vlan_mappings
(headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Create VN-Vlan Mappings in bulk.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (list) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
bulk_request_create
(headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for bulk_create_vn_vlan_mappings
-
bulk_delete_vn_vlan_mappings
(headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Delete VN-Vlan Mappings in bulk.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (list) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
bulk_request_delete
(headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for bulk_delete_vn_vlan_mappings
-
bulk_update_vn_vlan_mappings
(headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Update VN-Vlan Mappings in bulk.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (list) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
bulk_request_update
(headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Alias for bulk_update_vn_vlan_mappings
-
get_vn_vlan_mapping_by_id
(id, headers=None, **query_parameters)[source]¶ Get VN-Vlan Mapping by id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
get_by_id
(id, headers=None, **query_parameters)[source]¶ Alias for get_vn_vlan_mapping_by_id
-
update_vn_vlan_mapping_by_id
(id, is_data=None, is_default_vlan=None, last_update=None, max_value=None, name=None, vn_id=None, vn_name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶ Update VN-Vlan Mapping.
- Parameters
id (basestring) – Identifier of the VN-Vlan Mapping, property of the request body.
is_data (boolean) – Flag which indicates whether the Vlan is data or voice type, property of the request body.
is_default_vlan (boolean) – Flag which indicates if the Vlan is default, property of the request body.
last_update (string) – Timestamp for the last update of the VN-Vlan Mapping, property of the request body.
max_value (integer) – Max value, property of the request body.
name (string) – Name of the Vlan, property of the request body.
vn_id (string) – Identifier for the associated Virtual Network which is required unless its name is provided, property of the request body.
vn_name (string) – Name of the associated Virtual Network to be used for identity if id is not provided, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
delete_vn_vlan_mapping_by_id
(id, headers=None, **query_parameters)[source]¶ Delete VN-Vlan Mapping.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
REST response with following properties:
headers(MyDict): response headers.
response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
-
Identity Services Engine Data Object¶
MyDict¶
-
class
MyDict
[source]¶ A Python _dict_ subclass which tries to act like JavaScript objects, so you can use the dot notation (.) to access members of the object. If the member doesn’t exist yet then it’s created when you assign something to it. Brackets notation (d[‘foo’]) is also possible.
DownloadResponse¶
-
class
DownloadResponse
[source]¶ Download Response wrapper.
Bases: urllib3.response.HTTPResponse. For more information check the urlib3 documentation
HTTP Response container.
-
property
data
¶ The HTTPResponse’s data
-
property
filename
¶ The downloaded filename
-
property
dirpath
¶ The downloaded directory path
-
property
path
¶ The download file path
-
property
RestResponse¶
-
class
RestResponse
[source]¶ RestResponse to represent the response of the calls to the Identity Services Engine APIs.
-
property
content
¶ The content (bytes) of the RestResponse.
-
property
text
¶ The text (str) of the RestResponse.
-
property
status_code
¶ The HTTP status code from the RestResponse.
-
property
response
¶ The response (MyDict) of the RestResponse.
-
property
headers
¶ The headers (MyDict) of the RestResponse.
-
property
Exceptions¶
-
exception
ciscoisesdkException
[source]¶ Bases:
Exception
Base class for all ciscoisesdk package exceptions.
-
exception
AccessTokenError
[source]¶ Bases:
ciscoisesdk.exceptions.ciscoisesdkException
Raised when an incorrect Identity Services Engine Access Token has been provided.
-
exception
VersionError
[source]¶ Bases:
ciscoisesdk.exceptions.ciscoisesdkException
Raised when an incorrect Identity Services Engine version has been provided.
-
exception
ApiError
[source]¶ Bases:
ciscoisesdk.exceptions.ciscoisesdkException
Errors returned in response to requests sent to the Identity Services Engine APIs.
Several data attributes are available for inspection.
-
response
= None¶ The
requests.Response
object returned from the API call.
-
request
= None¶ The
requests.PreparedRequest
of the API call.
-
status_code
= None¶ The HTTP status code from the API response.
-
status
= None¶ The HTTP status from the API response.
-
details_str
= None¶ The text from the API response.
-
details
= None¶ The parsed JSON details from the API response.
-
message
= None¶ The error message from the parsed API response.
-
description
= None¶ A description of the HTTP Response Code from the API docs.
-
additional_data
= None¶ Additional data describing the issue
-
-
exception
RateLimitError
[source]¶ Bases:
ciscoisesdk.exceptions.ApiError
Identity Services Engine Rate-Limit exceeded Error.
Raised when a rate-limit exceeded message is received and the request will not be retried.
-
retry_after
= None¶ The Retry-After time period (in seconds) provided by Identity Services Engine.
Defaults to 15 seconds if the response Retry-After header isn’t present in the response headers, and defaults to a minimum wait time of 1 second if Identity Services Engine returns a Retry-After header of 0 seconds.
-
-
exception
RateLimitWarning
[source]¶ Bases:
UserWarning
Identity Services Engine rate-limit exceeded warning.
Raised when a rate-limit exceeded message is received and the request will be retried.
-
retry_after
= None¶ The Retry-After time period (in seconds) provided by Identity Services Engine.
Defaults to 15 seconds if the response Retry-After header isn’t present in the response headers, and defaults to a minimum wait time of 1 second if Identity Services Engine returns a Retry-After header of 0 seconds.
-
-
exception
MalformedRequest
[source]¶ Bases:
ciscoisesdk.exceptions.ciscoisesdkException
Raised when a malformed request is received from Identity Services Engine user.
-
exception
DownloadFailure
[source]¶ Bases:
ciscoisesdk.exceptions.ciscoisesdkException
Errors returned in response to requests sent to the Identity Services Engine APIs with stream=True.
Several data attributes are available for inspection.
-
response
= None¶ The
requests.Response
object returned from the API call.
-
request
= None¶ The
requests.PreparedRequest
of the API call.
-
status_code
= None¶ The HTTP status code from the API response.
-
status
= None¶ The HTTP status from the API response.
-
original_error
= None¶ The original exception
-
raw
= None¶ The raw value of the API response
-
Copyright (c) 2021 Cisco and/or its affiliates.