pxcloud_api_client.InsightsApi

All URIs are relative to https://api-cx.cisco.com/px

Method	HTTP request	Description
software_group_assets	GET /v1/customers/{customerId}/insights/software/softwareGroups/assets	Asset information in the Software Group
software_group_field_notices	GET /v1/customers/{customerId}/insights/software/softwareGroups/suggestions/fieldNotices	Software Group - Suggestions Field Notices
software_group_security_advisories	GET /v1/customers/{customerId}/insights/software/softwareGroups/suggestions/securityAdvisories	Software Group - Suggestions Security Advisories
software_group_suggestions	GET /v1/customers/{customerId}/insights/software/softwareGroups/suggestions	Software Group Suggestions
software_group_suggestions_bugs	GET /v1/customers/{customerId}/insights/software/softwareGroups/suggestions/bugs	Software Group - Suggestions Bugs
software_groups	GET /v1/customers/{customerId}/insights/software/softwareGroups	Software Group Information

software_group_assets

AssetResponse software_group_assets(customer_id, success_track_id, software_group_id)

Asset information in the Software Group

Returns information about assets in the Software Group based on the customerId and softwareGroupId provided

Example

OAuth Authentication (oAuth2):

import time
import pxcloud_api_client
from pxcloud_api_client.api import insights_api
from pxcloud_api_client.model.error_response import ErrorResponse
from pxcloud_api_client.model.asset_response import AssetResponse
from pprint import pprint
# Defining the host is optional and defaults to https://api-cx.cisco.com/px
# See configuration.py for a list of all supported configuration parameters.
configuration = pxcloud_api_client.Configuration(
    host = "https://api-cx.cisco.com/px"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure OAuth2 access token for authorization: oAuth2
configuration = pxcloud_api_client.Configuration(
    host = "https://api-cx.cisco.com/px"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with pxcloud_api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = insights_api.InsightsApi(api_client)
    customer_id = "customerId_example" # str | Unique identifier of the customer
    success_track_id = "successTrackId_example" # str | 
    software_group_id = "softwareGroupId_example" # str | Unique identifier used in CX Cloud to identify the Software Group
    offset = 1 # int | The number of items to skip before starting to collect the result set. The default value is 1. (optional)
    max = 50 # int | The maximum number of items to return (optional) if omitted the server will use the default value of 50

    # example passing only required values which don't have defaults set
    try:
        # Asset information in the Software Group
        api_response = api_instance.software_group_assets(customer_id, success_track_id, software_group_id)
        pprint(api_response)
    except pxcloud_api_client.ApiException as e:
        print("Exception when calling InsightsApi->software_group_assets: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Asset information in the Software Group
        api_response = api_instance.software_group_assets(customer_id, success_track_id, software_group_id, offset=offset, max=max)
        pprint(api_response)
    except pxcloud_api_client.ApiException as e:
        print("Exception when calling InsightsApi->software_group_assets: %s\n" % e)

Parameters

Name	Type	Description	Notes
customer_id	str	Unique identifier of the customer
success_track_id	str
software_group_id	str	Unique identifier used in CX Cloud to identify the Software Group
offset	int	The number of items to skip before starting to collect the result set. The default value is 1.	[optional]
max	int	The maximum number of items to return	[optional] if omitted the server will use the default value of 50

Return type

AssetResponse

Authorization

oAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	* Date -
401	Unauthorized	* Date -
403	Forbidden	* Date -
404	Not Found	* Date -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

software_group_field_notices

SoftwareGroupFieldNoticesResponse software_group_field_notices(customer_id, success_track_id, machine_suggestion_id)

Software Group - Suggestions Field Notices

This API returns field notice information, including ID number, title, and publish date.

Example

OAuth Authentication (oAuth2):

import time
import pxcloud_api_client
from pxcloud_api_client.api import insights_api
from pxcloud_api_client.model.error_response import ErrorResponse
from pxcloud_api_client.model.software_group_field_notices_response import SoftwareGroupFieldNoticesResponse
from pprint import pprint
# Defining the host is optional and defaults to https://api-cx.cisco.com/px
# See configuration.py for a list of all supported configuration parameters.
configuration = pxcloud_api_client.Configuration(
    host = "https://api-cx.cisco.com/px"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure OAuth2 access token for authorization: oAuth2
configuration = pxcloud_api_client.Configuration(
    host = "https://api-cx.cisco.com/px"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with pxcloud_api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = insights_api.InsightsApi(api_client)
    customer_id = "customerId_example" # str | Unique identifier of the customer
    success_track_id = "successTrackId_example" # str | 
    machine_suggestion_id = "machineSuggestionId_example" # str | 
    offset = 1 # int | The number of items to skip before starting to collect the result set. The default value is 1. (optional)
    max = 50 # int | The maximum number of items to return (optional) if omitted the server will use the default value of 50

    # example passing only required values which don't have defaults set
    try:
        # Software Group - Suggestions Field Notices
        api_response = api_instance.software_group_field_notices(customer_id, success_track_id, machine_suggestion_id)
        pprint(api_response)
    except pxcloud_api_client.ApiException as e:
        print("Exception when calling InsightsApi->software_group_field_notices: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Software Group - Suggestions Field Notices
        api_response = api_instance.software_group_field_notices(customer_id, success_track_id, machine_suggestion_id, offset=offset, max=max)
        pprint(api_response)
    except pxcloud_api_client.ApiException as e:
        print("Exception when calling InsightsApi->software_group_field_notices: %s\n" % e)

Parameters

Name	Type	Description	Notes
customer_id	str	Unique identifier of the customer
success_track_id	str
machine_suggestion_id	str
offset	int	The number of items to skip before starting to collect the result set. The default value is 1.	[optional]
max	int	The maximum number of items to return	[optional] if omitted the server will use the default value of 50

Return type

SoftwareGroupFieldNoticesResponse

Authorization

oAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	* Date -
401	Unauthorized	* Date -
403	Forbidden	* Date -
404	Not Found	* Date -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

software_group_security_advisories

SoftwareGroupSecurityAdvisoriesResponse software_group_security_advisories(customer_id, success_track_id, machine_suggestion_id)

Software Group - Suggestions Security Advisories

This API returns software advisory information, including ID number, version number, and severity level.

Example

OAuth Authentication (oAuth2):

import time
import pxcloud_api_client
from pxcloud_api_client.api import insights_api
from pxcloud_api_client.model.error_response import ErrorResponse
from pxcloud_api_client.model.software_group_security_advisories_response import SoftwareGroupSecurityAdvisoriesResponse
from pprint import pprint
# Defining the host is optional and defaults to https://api-cx.cisco.com/px
# See configuration.py for a list of all supported configuration parameters.
configuration = pxcloud_api_client.Configuration(
    host = "https://api-cx.cisco.com/px"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure OAuth2 access token for authorization: oAuth2
configuration = pxcloud_api_client.Configuration(
    host = "https://api-cx.cisco.com/px"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with pxcloud_api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = insights_api.InsightsApi(api_client)
    customer_id = "customerId_example" # str | Unique identifier of the customer
    success_track_id = "successTrackId_example" # str | 
    machine_suggestion_id = "machineSuggestionId_example" # str | 
    offset = 1 # int | The number of items to skip before starting to collect the result set. The default value is 1. (optional)
    max = 50 # int | The maximum number of items to return (optional) if omitted the server will use the default value of 50

    # example passing only required values which don't have defaults set
    try:
        # Software Group - Suggestions Security Advisories
        api_response = api_instance.software_group_security_advisories(customer_id, success_track_id, machine_suggestion_id)
        pprint(api_response)
    except pxcloud_api_client.ApiException as e:
        print("Exception when calling InsightsApi->software_group_security_advisories: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Software Group - Suggestions Security Advisories
        api_response = api_instance.software_group_security_advisories(customer_id, success_track_id, machine_suggestion_id, offset=offset, max=max)
        pprint(api_response)
    except pxcloud_api_client.ApiException as e:
        print("Exception when calling InsightsApi->software_group_security_advisories: %s\n" % e)

Parameters

Name	Type	Description	Notes
customer_id	str	Unique identifier of the customer
success_track_id	str
machine_suggestion_id	str
offset	int	The number of items to skip before starting to collect the result set. The default value is 1.	[optional]
max	int	The maximum number of items to return	[optional] if omitted the server will use the default value of 50

Return type

SoftwareGroupSecurityAdvisoriesResponse

Authorization

oAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	* Date -
401	Unauthorized	* Date -
403	Forbidden	* Date -
404	Not Found	* Date -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

software_group_suggestions

SoftwareGroupSuggestions software_group_suggestions(customer_id, success_track_id, suggestion_id)

Software Group Suggestions

Returns Software Group suggestions, including detailed information about Cisco software release recommendations and current Cisco software releases running on assets in the Software Group

Example

OAuth Authentication (oAuth2):

import time
import pxcloud_api_client
from pxcloud_api_client.api import insights_api
from pxcloud_api_client.model.error_response import ErrorResponse
from pxcloud_api_client.model.software_group_suggestions import SoftwareGroupSuggestions
from pprint import pprint
# Defining the host is optional and defaults to https://api-cx.cisco.com/px
# See configuration.py for a list of all supported configuration parameters.
configuration = pxcloud_api_client.Configuration(
    host = "https://api-cx.cisco.com/px"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure OAuth2 access token for authorization: oAuth2
configuration = pxcloud_api_client.Configuration(
    host = "https://api-cx.cisco.com/px"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with pxcloud_api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = insights_api.InsightsApi(api_client)
    customer_id = "customerId_example" # str | Unique identifier of the customer
    success_track_id = "successTrackId_example" # str | 
    suggestion_id = "suggestionId_example" # str | 

    # example passing only required values which don't have defaults set
    try:
        # Software Group Suggestions
        api_response = api_instance.software_group_suggestions(customer_id, success_track_id, suggestion_id)
        pprint(api_response)
    except pxcloud_api_client.ApiException as e:
        print("Exception when calling InsightsApi->software_group_suggestions: %s\n" % e)

Parameters

Name	Type	Description
customer_id	str	Unique identifier of the customer
success_track_id	str
suggestion_id	str

Return type

SoftwareGroupSuggestions

Authorization

oAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	* Date -
401	Unauthorized	* Date -
403	Forbidden	* Date -
404	Not Found	* Date -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

software_group_suggestions_bugs

SoftwareGroupBugsResponse software_group_suggestions_bugs(customer_id, success_track_id, machine_suggestion_id)

Software Group - Suggestions Bugs

This API returns information on bugs, including ID, description, and affected software releases.

Example

OAuth Authentication (oAuth2):

import time
import pxcloud_api_client
from pxcloud_api_client.api import insights_api
from pxcloud_api_client.model.error_response import ErrorResponse
from pxcloud_api_client.model.software_group_bugs_response import SoftwareGroupBugsResponse
from pprint import pprint
# Defining the host is optional and defaults to https://api-cx.cisco.com/px
# See configuration.py for a list of all supported configuration parameters.
configuration = pxcloud_api_client.Configuration(
    host = "https://api-cx.cisco.com/px"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure OAuth2 access token for authorization: oAuth2
configuration = pxcloud_api_client.Configuration(
    host = "https://api-cx.cisco.com/px"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with pxcloud_api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = insights_api.InsightsApi(api_client)
    customer_id = "customerId_example" # str | Unique identifier of the customer
    success_track_id = "successTrackId_example" # str | 
    machine_suggestion_id = "machineSuggestionId_example" # str | 
    offset = 1 # int | The number of items to skip before starting to collect the result set. The default value is 1. (optional)
    max = 50 # int | The maximum number of items to return (optional) if omitted the server will use the default value of 50

    # example passing only required values which don't have defaults set
    try:
        # Software Group - Suggestions Bugs
        api_response = api_instance.software_group_suggestions_bugs(customer_id, success_track_id, machine_suggestion_id)
        pprint(api_response)
    except pxcloud_api_client.ApiException as e:
        print("Exception when calling InsightsApi->software_group_suggestions_bugs: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Software Group - Suggestions Bugs
        api_response = api_instance.software_group_suggestions_bugs(customer_id, success_track_id, machine_suggestion_id, offset=offset, max=max)
        pprint(api_response)
    except pxcloud_api_client.ApiException as e:
        print("Exception when calling InsightsApi->software_group_suggestions_bugs: %s\n" % e)

Parameters

Name	Type	Description	Notes
customer_id	str	Unique identifier of the customer
success_track_id	str
machine_suggestion_id	str
offset	int	The number of items to skip before starting to collect the result set. The default value is 1.	[optional]
max	int	The maximum number of items to return	[optional] if omitted the server will use the default value of 50

Return type

SoftwareGroupBugsResponse

Authorization

oAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	* Date -
401	Unauthorized	* Date -
403	Forbidden	* Date -
404	Not Found	* Date -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

software_groups

SoftwareGroupResponse software_groups(success_track_id, customer_id)

Software Group Information

Returns Software Group information for the customerId provided

Example

OAuth Authentication (oAuth2):

import time
import pxcloud_api_client
from pxcloud_api_client.api import insights_api
from pxcloud_api_client.model.error_response import ErrorResponse
from pxcloud_api_client.model.software_group_response import SoftwareGroupResponse
from pprint import pprint
# Defining the host is optional and defaults to https://api-cx.cisco.com/px
# See configuration.py for a list of all supported configuration parameters.
configuration = pxcloud_api_client.Configuration(
    host = "https://api-cx.cisco.com/px"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure OAuth2 access token for authorization: oAuth2
configuration = pxcloud_api_client.Configuration(
    host = "https://api-cx.cisco.com/px"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with pxcloud_api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = insights_api.InsightsApi(api_client)
    success_track_id = "successTrackId_example" # str | 
    customer_id = "customerId_example" # str | Unique identifier of the customer
    offset = 1 # int | The number of items to skip before starting to collect the result set. The default value is 1. (optional)
    max = 50 # int | The maximum number of items to return (optional) if omitted the server will use the default value of 50

    # example passing only required values which don't have defaults set
    try:
        # Software Group Information
        api_response = api_instance.software_groups(success_track_id, customer_id)
        pprint(api_response)
    except pxcloud_api_client.ApiException as e:
        print("Exception when calling InsightsApi->software_groups: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Software Group Information
        api_response = api_instance.software_groups(success_track_id, customer_id, offset=offset, max=max)
        pprint(api_response)
    except pxcloud_api_client.ApiException as e:
        print("Exception when calling InsightsApi->software_groups: %s\n" % e)

Parameters

Name	Type	Description	Notes
success_track_id	str
customer_id	str	Unique identifier of the customer
offset	int	The number of items to skip before starting to collect the result set. The default value is 1.	[optional]
max	int	The maximum number of items to return	[optional] if omitted the server will use the default value of 50

Return type

SoftwareGroupResponse

Authorization

oAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	* Date -
401	Unauthorized	* Date -
403	Forbidden	* Date -
404	Not Found	* Date -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

InsightsApi.md

Latest commit

History

InsightsApi.md

File metadata and controls

pxcloud_api_client.InsightsApi

software_group_assets

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

software_group_field_notices

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

software_group_security_advisories

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

software_group_suggestions

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

software_group_suggestions_bugs

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

software_groups

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details