openapi_client.ConfigurationDeviceSoftwareUpdateApi

All URIs are relative to /dataservice

Method	HTTP request	Description
download_package_file	GET /device/action/software/package/{fileName}
edit_image_metadata	PUT /device/action/software/package/{versionId}/metadata
get_image_metadata	GET /device/action/software/package/{versionId}/metadata
get_upload_images_count	GET /device/action/software/package/imageCount
install_pkg	POST /device/action/software/package
process_software_image	POST /device/action/software/package/{imageType}

download_package_file

download_package_file(file_name, )

Download software package file

Example

import time
import openapi_client
from openapi_client.api import configuration_device_software_update_api
from pprint import pprint
# Defining the host is optional and defaults to /dataservice
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "/dataservice"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = configuration_device_software_update_api.ConfigurationDeviceSoftwareUpdateApi(api_client)
    file_name = "fileName_example" # str | Pakcage file name

    # example passing only required values which don't have defaults set
    try:
        api_instance.download_package_file(file_name, )
    except openapi_client.ApiException as e:
        print("Exception when calling ConfigurationDeviceSoftwareUpdateApi->download_package_file: %s\n" % e)

Parameters

Name	Type	Description	Notes
file_name	str	Pakcage file name
image_type	str	Image type	defaults to "software"

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	Success	-
400	Bad Request	-
403	Forbidden	-
500	Internal Server Error	-

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

edit_image_metadata

edit_image_metadata(version_id)

Update Package Metadata

Example

import time
import openapi_client
from openapi_client.api import configuration_device_software_update_api
from pprint import pprint
# Defining the host is optional and defaults to /dataservice
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "/dataservice"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = configuration_device_software_update_api.ConfigurationDeviceSoftwareUpdateApi(api_client)
    version_id = "versionId_example" # str | Image ID
    body = "body_example" # str |  (optional)

    # example passing only required values which don't have defaults set
    try:
        api_instance.edit_image_metadata(version_id)
    except openapi_client.ApiException as e:
        print("Exception when calling ConfigurationDeviceSoftwareUpdateApi->edit_image_metadata: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        api_instance.edit_image_metadata(version_id, body=body)
    except openapi_client.ApiException as e:
        print("Exception when calling ConfigurationDeviceSoftwareUpdateApi->edit_image_metadata: %s\n" % e)

Parameters

Name	Type	Description	Notes
version_id	str	Image ID
body	str		[optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	Success	-
400	Bad Request	-
403	Forbidden	-
500	Internal Server Error	-

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

get_image_metadata

get_image_metadata(version_id)

Update Package Metadata

Example

import time
import openapi_client
from openapi_client.api import configuration_device_software_update_api
from pprint import pprint
# Defining the host is optional and defaults to /dataservice
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "/dataservice"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = configuration_device_software_update_api.ConfigurationDeviceSoftwareUpdateApi(api_client)
    version_id = "versionId_example" # str | Image ID

    # example passing only required values which don't have defaults set
    try:
        api_instance.get_image_metadata(version_id)
    except openapi_client.ApiException as e:
        print("Exception when calling ConfigurationDeviceSoftwareUpdateApi->get_image_metadata: %s\n" % e)

Parameters

Name	Type	Description	Notes
version_id	str	Image ID

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	Success	-
400	Bad Request	-
403	Forbidden	-
500	Internal Server Error	-

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

get_upload_images_count

get_upload_images_count(image_type)

Number of software image presented in vManage repository

Example

import time
import openapi_client
from openapi_client.api import configuration_device_software_update_api
from pprint import pprint
# Defining the host is optional and defaults to /dataservice
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "/dataservice"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = configuration_device_software_update_api.ConfigurationDeviceSoftwareUpdateApi(api_client)
    image_type = [
        "software",
    ] # [str] | Image type

    # example passing only required values which don't have defaults set
    try:
        api_instance.get_upload_images_count(image_type)
    except openapi_client.ApiException as e:
        print("Exception when calling ConfigurationDeviceSoftwareUpdateApi->get_upload_images_count: %s\n" % e)

Parameters

Name	Type	Description	Notes
image_type	[str]	Image type

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	Success	-
400	Bad Request	-
403	Forbidden	-
500	Internal Server Error	-

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

install_pkg

install_pkg()

Install software package

Example

import time
import openapi_client
from openapi_client.api import configuration_device_software_update_api
from openapi_client.model.software_upload_file_data import SoftwareUploadFileData
from pprint import pprint
# Defining the host is optional and defaults to /dataservice
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "/dataservice"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = configuration_device_software_update_api.ConfigurationDeviceSoftwareUpdateApi(api_client)
    data = SoftwareUploadFileData(
        key=GetO365PreferredPathFromVAnalyticsRequestValue(
            value_type="ARRAY",
        ),
    ) # SoftwareUploadFileData |  (optional)
    file = open('/path/to/file', 'rb') # file_type |  (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        api_instance.install_pkg(data=data, file=file)
    except openapi_client.ApiException as e:
        print("Exception when calling ConfigurationDeviceSoftwareUpdateApi->install_pkg: %s\n" % e)

Parameters

Name	Type	Description	Notes
data	SoftwareUploadFileData		[optional]
file	file_type		[optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: multipart/form-data
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	Success	-
400	Bad Request	-
403	Forbidden	-
415	Unsupported Media Type	-
500	Internal Server Error	-

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

process_software_image

process_software_image(image_type)

Install software image package

Example

import time
import openapi_client
from openapi_client.api import configuration_device_software_update_api
from openapi_client.model.software_upload_file_data import SoftwareUploadFileData
from pprint import pprint
# Defining the host is optional and defaults to /dataservice
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "/dataservice"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = configuration_device_software_update_api.ConfigurationDeviceSoftwareUpdateApi(api_client)
    image_type = "imageType_example" # str | Image type
    data = SoftwareUploadFileData(
        key=GetO365PreferredPathFromVAnalyticsRequestValue(
            value_type="ARRAY",
        ),
    ) # SoftwareUploadFileData |  (optional)
    file = open('/path/to/file', 'rb') # file_type |  (optional)

    # example passing only required values which don't have defaults set
    try:
        api_instance.process_software_image(image_type)
    except openapi_client.ApiException as e:
        print("Exception when calling ConfigurationDeviceSoftwareUpdateApi->process_software_image: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        api_instance.process_software_image(image_type, data=data, file=file)
    except openapi_client.ApiException as e:
        print("Exception when calling ConfigurationDeviceSoftwareUpdateApi->process_software_image: %s\n" % e)

Parameters

Name	Type	Description	Notes
image_type	str	Image type
data	SoftwareUploadFileData		[optional]
file	file_type		[optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: multipart/form-data
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	Success	-
400	Bad Request	-
403	Forbidden	-
415	Unsupported Media Type	-
500	Internal Server Error	-

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

Files

ConfigurationDeviceSoftwareUpdateApi.md

Latest commit

History

ConfigurationDeviceSoftwareUpdateApi.md

File metadata and controls

openapi_client.ConfigurationDeviceSoftwareUpdateApi

download_package_file

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

edit_image_metadata

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_image_metadata

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_upload_images_count

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

install_pkg

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

process_software_image

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details