Skip to content

Latest commit

 

History

History
666 lines (548 loc) · 37.8 KB

DiagnosticsV1Api.md

File metadata and controls

666 lines (548 loc) · 37.8 KB
Raw

psm.DiagnosticsV1Api

All URIs are relative to https://PSM-IP-addr

Method HTTP request Description
debug POST /configs/diagnostics/v1/modules/{O.Name}/Debug Request Diagnostics information for a module
get_module GET /configs/diagnostics/v1/modules/{O.Name} Get Module object
label_module POST /configs/diagnostics/v1/modules/{O.Name}/label Label Module object
list_module GET /configs/diagnostics/v1/modules List Module objects
update_module PUT /configs/diagnostics/v1/modules/{O.Name} Update Module object
watch_module GET /configs/diagnostics/v1/watch/modules Watch Module objects. Supports WebSockets or HTTP long poll

debug

DiagnosticsDiagnosticsResponse debug(o_name, body)

Request Diagnostics information for a module

Example

Ensure that PSM_USER and PSM_PASSWORD are set in your environment

import time
import os
import pensando_ent
import pensando_ent.psm
from pensando_ent.psm.api import diagnostics_v1_api
from pensando_ent.psm.models.diagnostics import *
from pensando_ent.psm.model.diagnostics_diagnostics_request import DiagnosticsDiagnosticsRequest
from pensando_ent.psm.model.diagnostics_diagnostics_response import DiagnosticsDiagnosticsResponse
from pensando_ent.psm.model.api_status import ApiStatus
from pprint import pprint
from dateutil.parser import parse as dateutil_parser
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = pensando_ent.psm.Configuration(
    psm_config_path = os.environ["HOME"] + "/.psm/config.json"
)
configuration.verify_ssl = False


# Enter a context with an instance of the API client
with pensando_ent.psm.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = diagnostics_v1_api.DiagnosticsV1Api(api_client)
    o_name = "O.Name_example" # str | 
    body = DiagnosticsDiagnosticsRequest(
        api_version="api_version_example",
        kind="kind_example",
        meta=ApiObjectMeta(
            creation_time=dateutil_parser('1970-01-01T00:00:00.00Z'),
            generation_id="generation_id_example",
            labels={
                "key": "key_example",
            },
            mod_time=dateutil_parser('1970-01-01T00:00:00.00Z'),
            name="name_example",
            namespace="namespace_example",
            resource_version="resource_version_example",
            self_link="self_link_example",
            tenant="tenant_example",
            uuid="uuid_example",
        ),
        parameters={
            "key": "key_example",
        },
        query="query_example",
        service_port=DiagnosticsServicePort(
            name="name_example",
            port=1,
        ),
    ) # DiagnosticsDiagnosticsRequest | 

    # example passing only required values which don't have defaults set
    try:
        # Request Diagnostics information for a module
        api_response = api_instance.debug(o_name, body)
        pprint(api_response)
    except pensando_ent.psm.ApiException as e:
        print("Exception when calling DiagnosticsV1Api->debug: %s\n" % e)

Parameters

Name Type Description Notes
o_name str
body DiagnosticsDiagnosticsRequest

Return type

DiagnosticsDiagnosticsResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 (empty) -
400 Bad request parameters -
401 Unauthorized request -
409 Conflict while processing request -
412 Pre-condition failed -
500 Internal server error -
501 Request not implemented -

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

get_module

DiagnosticsModule get_module(o_name)

Get Module object

Example

Ensure that PSM_USER and PSM_PASSWORD are set in your environment

import time
import os
import pensando_ent
import pensando_ent.psm
from pensando_ent.psm.api import diagnostics_v1_api
from pensando_ent.psm.models.diagnostics import *
from pensando_ent.psm.model.diagnostics_module import DiagnosticsModule
from pensando_ent.psm.model.api_status import ApiStatus
from pprint import pprint
from dateutil.parser import parse as dateutil_parser
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = pensando_ent.psm.Configuration(
    psm_config_path = os.environ["HOME"] + "/.psm/config.json"
)
configuration.verify_ssl = False


# Enter a context with an instance of the API client
with pensando_ent.psm.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = diagnostics_v1_api.DiagnosticsV1Api(api_client)
    o_name = "O.Name_example" # str | 
    t_kind = "T.kind_example" # str | Kind represents the type of the API object. (optional)
    t_api_version = "T.api-version_example" # str | APIVersion defines the version of the API object. This can only be set by the server. (optional)
    meta_tenant = "meta.tenant_example" # str | Tenant to which the object belongs to. This can be automatically filled in many cases based on the tenant the user, who created the object, belongs to. Must be alpha-numerics. Length of string should be between 1 and 48. (optional)
    meta_namespace = "meta.namespace_example" # str | Namespace of the object, for scoped objects. Must start and end with alpha numeric and can have alphanumeric, -, _, . Length of string should be between 2 and 64. (optional)
    meta_generation_id = "meta.generation-id_example" # str | GenerationID is the generation Id for the object. This is incremented anytime there is an update to the user intent, including Spec update and any update to ObjectMeta. System generated and updated, not updatable by user. (optional)
    meta_resource_version = "meta.resource-version_example" # str | Resource version in the object store. This is updated anytime there is any change to the object. System generated and updated, not updatable by user. (optional)
    meta_uuid = "meta.uuid_example" # str | UUID is the unique identifier for the object. This is generated on creation of the object. System generated, not updatable by user. (optional)
    meta_creation_time = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | CreationTime is the creation time of the object. System generated and updated, not updatable by user. (optional)
    meta_mod_time = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | ModTime is the Last Modification time of the object. System generated and updated, not updatable by user. (optional)
    meta_self_link = "meta.self-link_example" # str | SelfLink is a link for accessing this object. When the object is served from the API-GW it is the URI path. Example: - \"/v1/tenants/tenants/tenant2\" System generated and updated, not updatable by user. (optional)
    spec_log_level = "spec.log-level_example" # str | LogLevel is the logging level of this module. Default is Info. (optional)
    spec_enable_trace = True # bool | EnableTrace enables traces for a module. Default is false. (optional)
    spec_args = [
        "spec.args_example",
    ] # [str] | Args are command line arguments passed to the module. (optional)
    status_node = "status.node_example" # str | Node on which this process is running. (optional)
    status_module = "status.module_example" # str | Module is the name of the process/container. (optional)
    status_category = "status.category_example" # str | Category specifies whether process is part of Venice(controller) or Naples(io) subsystem. (optional)
    status_last_start = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Last start time. (optional)
    status_restart_count = 1 # int | Number of times process got restarted. zero if never restarted. (optional)
    status_last_restart_reason = "status.last-restart-reason_example" # str | Arbitrary string, json, backtrace, etc. offering clues for restart. (optional)
    status_service = "status.service_example" # str | Service is the name of the service/pod this process is part of. (optional)
    status_mac_address = "status.mac-address_example" # str | MACAddress of the smart nic on which this module runs. (optional)

    # example passing only required values which don't have defaults set
    try:
        # Get Module object
        api_response = api_instance.get_module(o_name)
        pprint(api_response)
    except pensando_ent.psm.ApiException as e:
        print("Exception when calling DiagnosticsV1Api->get_module: %s\n" % e)

Parameters

Name Type Description Notes
o_name str
t_kind str Kind represents the type of the API object. [optional]
t_api_version str APIVersion defines the version of the API object. This can only be set by the server. [optional]
meta_tenant str Tenant to which the object belongs to. This can be automatically filled in many cases based on the tenant the user, who created the object, belongs to. Must be alpha-numerics. Length of string should be between 1 and 48. [optional]
meta_namespace str Namespace of the object, for scoped objects. Must start and end with alpha numeric and can have alphanumeric, -, _, . Length of string should be between 2 and 64. [optional]
meta_generation_id str GenerationID is the generation Id for the object. This is incremented anytime there is an update to the user intent, including Spec update and any update to ObjectMeta. System generated and updated, not updatable by user. [optional]
meta_resource_version str Resource version in the object store. This is updated anytime there is any change to the object. System generated and updated, not updatable by user. [optional]
meta_uuid str UUID is the unique identifier for the object. This is generated on creation of the object. System generated, not updatable by user. [optional]
meta_creation_time datetime CreationTime is the creation time of the object. System generated and updated, not updatable by user. [optional]
meta_mod_time datetime ModTime is the Last Modification time of the object. System generated and updated, not updatable by user. [optional]
meta_self_link str SelfLink is a link for accessing this object. When the object is served from the API-GW it is the URI path. Example: - "/v1/tenants/tenants/tenant2" System generated and updated, not updatable by user. [optional]
spec_log_level str LogLevel is the logging level of this module. Default is Info. [optional]
spec_enable_trace bool EnableTrace enables traces for a module. Default is false. [optional]
spec_args [str] Args are command line arguments passed to the module. [optional]
status_node str Node on which this process is running. [optional]
status_module str Module is the name of the process/container. [optional]
status_category str Category specifies whether process is part of Venice(controller) or Naples(io) subsystem. [optional]
status_last_start datetime Last start time. [optional]
status_restart_count int Number of times process got restarted. zero if never restarted. [optional]
status_last_restart_reason str Arbitrary string, json, backtrace, etc. offering clues for restart. [optional]
status_service str Service is the name of the service/pod this process is part of. [optional]
status_mac_address str MACAddress of the smart nic on which this module runs. [optional]

Return type

DiagnosticsModule

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 (empty) -
400 Bad request parameters -
401 Unauthorized request -
409 Conflict while processing request -
412 Pre-condition failed -
500 Internal server error -
501 Request not implemented -

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

label_module

DiagnosticsModule label_module(o_name, body)

Label Module object

Example

Ensure that PSM_USER and PSM_PASSWORD are set in your environment

import time
import os
import pensando_ent
import pensando_ent.psm
from pensando_ent.psm.api import diagnostics_v1_api
from pensando_ent.psm.models.diagnostics import *
from pensando_ent.psm.model.diagnostics_module import DiagnosticsModule
from pensando_ent.psm.model.api_label import ApiLabel
from pensando_ent.psm.model.api_status import ApiStatus
from pprint import pprint
from dateutil.parser import parse as dateutil_parser
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = pensando_ent.psm.Configuration(
    psm_config_path = os.environ["HOME"] + "/.psm/config.json"
)
configuration.verify_ssl = False


# Enter a context with an instance of the API client
with pensando_ent.psm.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = diagnostics_v1_api.DiagnosticsV1Api(api_client)
    o_name = "O.Name_example" # str | 
    body = ApiLabel(
        api_version="api_version_example",
        creation_time=dateutil_parser('1970-01-01T00:00:00.00Z'),
        generation_id="generation_id_example",
        kind="kind_example",
        labels={
            "key": "key_example",
        },
        mod_time=dateutil_parser('1970-01-01T00:00:00.00Z'),
        name="g6bUUGjjNSwg0_bs9ZayIMrKdgNvb",
        namespace="g6bUUGjjNSwg0_bs9ZayIMrKdgNvb",
        resource_version="resource_version_example",
        self_link="self_link_example",
        tenant="C",
        uuid="uuid_example",
    ) # ApiLabel | 

    # example passing only required values which don't have defaults set
    try:
        # Label Module object
        api_response = api_instance.label_module(o_name, body)
        pprint(api_response)
    except pensando_ent.psm.ApiException as e:
        print("Exception when calling DiagnosticsV1Api->label_module: %s\n" % e)

Parameters

Name Type Description Notes
o_name str
body ApiLabel

Return type

DiagnosticsModule

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 (empty) -
400 Bad request parameters -
401 Unauthorized request -
409 Conflict while processing request -
412 Pre-condition failed -
500 Internal server error -
501 Request not implemented -

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

list_module

DiagnosticsModuleList list_module()

List Module objects

Example

Ensure that PSM_USER and PSM_PASSWORD are set in your environment

import time
import os
import pensando_ent
import pensando_ent.psm
from pensando_ent.psm.api import diagnostics_v1_api
from pensando_ent.psm.models.diagnostics import *
from pensando_ent.psm.model.diagnostics_module_list import DiagnosticsModuleList
from pensando_ent.psm.model.api_status import ApiStatus
from pprint import pprint
from dateutil.parser import parse as dateutil_parser
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = pensando_ent.psm.Configuration(
    psm_config_path = os.environ["HOME"] + "/.psm/config.json"
)
configuration.verify_ssl = False


# Enter a context with an instance of the API client
with pensando_ent.psm.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = diagnostics_v1_api.DiagnosticsV1Api(api_client)
    o_name = "O.name_example" # str | Name of the object, unique within a Namespace for scoped objects. Must start and end with alpha numeric and can have alphanumeric, -, _, . Length of string should be between 2 and 64. (optional)
    o_tenant = "O.tenant_example" # str | Tenant to which the object belongs to. This can be automatically filled in many cases based on the tenant the user, who created the object, belongs to. Must be alpha-numerics. Length of string should be between 1 and 48. (optional)
    o_namespace = "O.namespace_example" # str | Namespace of the object, for scoped objects. Must start and end with alpha numeric and can have alphanumeric, -, _, . Length of string should be between 2 and 64. (optional)
    o_generation_id = "O.generation-id_example" # str | GenerationID is the generation Id for the object. This is incremented anytime there is an update to the user intent, including Spec update and any update to ObjectMeta. System generated and updated, not updatable by user. (optional)
    o_resource_version = "O.resource-version_example" # str | Resource version in the object store. This is updated anytime there is any change to the object. System generated and updated, not updatable by user. (optional)
    o_uuid = "O.uuid_example" # str | UUID is the unique identifier for the object. This is generated on creation of the object. System generated, not updatable by user. (optional)
    o_creation_time = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | CreationTime is the creation time of the object. System generated and updated, not updatable by user. (optional)
    o_mod_time = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | ModTime is the Last Modification time of the object. System generated and updated, not updatable by user. (optional)
    o_self_link = "O.self-link_example" # str | SelfLink is a link for accessing this object. When the object is served from the API-GW it is the URI path. Example: - \"/v1/tenants/tenants/tenant2\" System generated and updated, not updatable by user. (optional)
    label_selector = "label-selector_example" # str | LabelSelector to select on labels in list or watch results. (optional)
    field_selector = "field-selector_example" # str | FieldSelector to select on field values in list or watch results. (optional)
    field_change_selector = [
        "field-change-selector_example",
    ] # [str] | FieldChangeSelector specifies to generate a watch notification on change in field(s) specified. (optional)
    _from = 1 # int | From represents the start index number (1 based - first object starts from index 1), of the results list. The results returned would be in the range [from ... (from + (max-results - 1))]. If From = 0, the server will attempt to return all the results in the list without pagination. (optional)
    max_results = 1 # int | MaxResults is the maximum number of results to be returned as part of the response, per page If MaxResults is more than the maximum number of results per page supported by the server, the server will return an err If MaxResults is 0, the server will return all the results without pagination. (optional)
    sort_order = "sort-order_example" # str | order to sort List results in. (optional)
    meta_only = True # bool | If MetaOnly is set to true, the watch event notification that matches the watch criteria will not contain the full object. It will only contain the information about the object that changed, i.e. which object and what changed. MetaOnly is not set by default. (optional)

    # example passing only required values which don't have defaults set
    try:
        # List Module objects
        api_response = api_instance.list_module()
        pprint(api_response)
    except pensando_ent.psm.ApiException as e:
        print("Exception when calling DiagnosticsV1Api->list_module: %s\n" % e)

Parameters

Name Type Description Notes
o_name str Name of the object, unique within a Namespace for scoped objects. Must start and end with alpha numeric and can have alphanumeric, -, _, . Length of string should be between 2 and 64. [optional]
o_tenant str Tenant to which the object belongs to. This can be automatically filled in many cases based on the tenant the user, who created the object, belongs to. Must be alpha-numerics. Length of string should be between 1 and 48. [optional]
o_namespace str Namespace of the object, for scoped objects. Must start and end with alpha numeric and can have alphanumeric, -, _, . Length of string should be between 2 and 64. [optional]
o_generation_id str GenerationID is the generation Id for the object. This is incremented anytime there is an update to the user intent, including Spec update and any update to ObjectMeta. System generated and updated, not updatable by user. [optional]
o_resource_version str Resource version in the object store. This is updated anytime there is any change to the object. System generated and updated, not updatable by user. [optional]
o_uuid str UUID is the unique identifier for the object. This is generated on creation of the object. System generated, not updatable by user. [optional]
o_creation_time datetime CreationTime is the creation time of the object. System generated and updated, not updatable by user. [optional]
o_mod_time datetime ModTime is the Last Modification time of the object. System generated and updated, not updatable by user. [optional]
o_self_link str SelfLink is a link for accessing this object. When the object is served from the API-GW it is the URI path. Example: - "/v1/tenants/tenants/tenant2" System generated and updated, not updatable by user. [optional]
label_selector str LabelSelector to select on labels in list or watch results. [optional]
field_selector str FieldSelector to select on field values in list or watch results. [optional]
field_change_selector [str] FieldChangeSelector specifies to generate a watch notification on change in field(s) specified. [optional]
_from int From represents the start index number (1 based - first object starts from index 1), of the results list. The results returned would be in the range [from ... (from + (max-results - 1))]. If From = 0, the server will attempt to return all the results in the list without pagination. [optional]
max_results int MaxResults is the maximum number of results to be returned as part of the response, per page If MaxResults is more than the maximum number of results per page supported by the server, the server will return an err If MaxResults is 0, the server will return all the results without pagination. [optional]
sort_order str order to sort List results in. [optional]
meta_only bool If MetaOnly is set to true, the watch event notification that matches the watch criteria will not contain the full object. It will only contain the information about the object that changed, i.e. which object and what changed. MetaOnly is not set by default. [optional]

Return type

DiagnosticsModuleList

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 (empty) -
400 Bad request parameters -
401 Unauthorized request -
409 Conflict while processing request -
412 Pre-condition failed -
500 Internal server error -
501 Request not implemented -

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

update_module

DiagnosticsModule update_module(o_name, body)

Update Module object

Example

Ensure that PSM_USER and PSM_PASSWORD are set in your environment

import time
import os
import pensando_ent
import pensando_ent.psm
from pensando_ent.psm.api import diagnostics_v1_api
from pensando_ent.psm.models.diagnostics import *
from pensando_ent.psm.model.diagnostics_module import DiagnosticsModule
from pensando_ent.psm.model.api_status import ApiStatus
from pprint import pprint
from dateutil.parser import parse as dateutil_parser
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = pensando_ent.psm.Configuration(
    psm_config_path = os.environ["HOME"] + "/.psm/config.json"
)
configuration.verify_ssl = False


# Enter a context with an instance of the API client
with pensando_ent.psm.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = diagnostics_v1_api.DiagnosticsV1Api(api_client)
    o_name = "O.Name_example" # str | 
    body = DiagnosticsModule(
        api_version="api_version_example",
        kind="kind_example",
        meta=ApiObjectMeta(
            creation_time=dateutil_parser('1970-01-01T00:00:00.00Z'),
            generation_id="generation_id_example",
            labels={
                "key": "key_example",
            },
            mod_time=dateutil_parser('1970-01-01T00:00:00.00Z'),
            name="name_example",
            namespace="namespace_example",
            resource_version="resource_version_example",
            self_link="self_link_example",
            tenant="tenant_example",
            uuid="uuid_example",
        ),
        spec=DiagnosticsModuleSpec(
            args=[
                "args_example",
            ],
            enable_trace=True,
            log_level="info",
        ),
        status=DiagnosticsModuleStatus(
            category="venice",
            last_restart_reason="last_restart_reason_example",
            last_start=dateutil_parser('1970-01-01T00:00:00.00Z'),
            mac_address="mac_address_example",
            module="module_example",
            node="node_example",
            restart_count=1,
            service="service_example",
            service_ports=[
                DiagnosticsServicePort(
                    name="name_example",
                    port=1,
                ),
            ],
        ),
    ) # DiagnosticsModule | 

    # example passing only required values which don't have defaults set
    try:
        # Update Module object
        api_response = api_instance.update_module(o_name, body)
        pprint(api_response)
    except pensando_ent.psm.ApiException as e:
        print("Exception when calling DiagnosticsV1Api->update_module: %s\n" % e)

Parameters

Name Type Description Notes
o_name str
body DiagnosticsModule

Return type

DiagnosticsModule

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 (empty) -
400 Bad request parameters -
401 Unauthorized request -
409 Conflict while processing request -
412 Pre-condition failed -
500 Internal server error -
501 Request not implemented -

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

watch_module

DiagnosticsAutoMsgModuleWatchHelper watch_module()

Watch Module objects. Supports WebSockets or HTTP long poll

Example

Ensure that PSM_USER and PSM_PASSWORD are set in your environment

import time
import os
import pensando_ent
import pensando_ent.psm
from pensando_ent.psm.api import diagnostics_v1_api
from pensando_ent.psm.models.diagnostics import *
from pensando_ent.psm.model.diagnostics_auto_msg_module_watch_helper import DiagnosticsAutoMsgModuleWatchHelper
from pensando_ent.psm.model.api_status import ApiStatus
from pprint import pprint
from dateutil.parser import parse as dateutil_parser
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = pensando_ent.psm.Configuration(
    psm_config_path = os.environ["HOME"] + "/.psm/config.json"
)
configuration.verify_ssl = False


# Enter a context with an instance of the API client
with pensando_ent.psm.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = diagnostics_v1_api.DiagnosticsV1Api(api_client)
    o_name = "O.name_example" # str | Name of the object, unique within a Namespace for scoped objects. Must start and end with alpha numeric and can have alphanumeric, -, _, . Length of string should be between 2 and 64. (optional)
    o_tenant = "O.tenant_example" # str | Tenant to which the object belongs to. This can be automatically filled in many cases based on the tenant the user, who created the object, belongs to. Must be alpha-numerics. Length of string should be between 1 and 48. (optional)
    o_namespace = "O.namespace_example" # str | Namespace of the object, for scoped objects. Must start and end with alpha numeric and can have alphanumeric, -, _, . Length of string should be between 2 and 64. (optional)
    o_generation_id = "O.generation-id_example" # str | GenerationID is the generation Id for the object. This is incremented anytime there is an update to the user intent, including Spec update and any update to ObjectMeta. System generated and updated, not updatable by user. (optional)
    o_resource_version = "O.resource-version_example" # str | Resource version in the object store. This is updated anytime there is any change to the object. System generated and updated, not updatable by user. (optional)
    o_uuid = "O.uuid_example" # str | UUID is the unique identifier for the object. This is generated on creation of the object. System generated, not updatable by user. (optional)
    o_creation_time = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | CreationTime is the creation time of the object. System generated and updated, not updatable by user. (optional)
    o_mod_time = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | ModTime is the Last Modification time of the object. System generated and updated, not updatable by user. (optional)
    o_self_link = "O.self-link_example" # str | SelfLink is a link for accessing this object. When the object is served from the API-GW it is the URI path. Example: - \"/v1/tenants/tenants/tenant2\" System generated and updated, not updatable by user. (optional)
    label_selector = "label-selector_example" # str | LabelSelector to select on labels in list or watch results. (optional)
    field_selector = "field-selector_example" # str | FieldSelector to select on field values in list or watch results. (optional)
    field_change_selector = [
        "field-change-selector_example",
    ] # [str] | FieldChangeSelector specifies to generate a watch notification on change in field(s) specified. (optional)
    _from = 1 # int | From represents the start index number (1 based - first object starts from index 1), of the results list. The results returned would be in the range [from ... (from + (max-results - 1))]. If From = 0, the server will attempt to return all the results in the list without pagination. (optional)
    max_results = 1 # int | MaxResults is the maximum number of results to be returned as part of the response, per page If MaxResults is more than the maximum number of results per page supported by the server, the server will return an err If MaxResults is 0, the server will return all the results without pagination. (optional)
    sort_order = "sort-order_example" # str | order to sort List results in. (optional)
    meta_only = True # bool | If MetaOnly is set to true, the watch event notification that matches the watch criteria will not contain the full object. It will only contain the information about the object that changed, i.e. which object and what changed. MetaOnly is not set by default. (optional)

    # example passing only required values which don't have defaults set
    try:
        # Watch Module objects. Supports WebSockets or HTTP long poll
        api_response = api_instance.watch_module()
        pprint(api_response)
    except pensando_ent.psm.ApiException as e:
        print("Exception when calling DiagnosticsV1Api->watch_module: %s\n" % e)

Parameters

Name Type Description Notes
o_name str Name of the object, unique within a Namespace for scoped objects. Must start and end with alpha numeric and can have alphanumeric, -, _, . Length of string should be between 2 and 64. [optional]
o_tenant str Tenant to which the object belongs to. This can be automatically filled in many cases based on the tenant the user, who created the object, belongs to. Must be alpha-numerics. Length of string should be between 1 and 48. [optional]
o_namespace str Namespace of the object, for scoped objects. Must start and end with alpha numeric and can have alphanumeric, -, _, . Length of string should be between 2 and 64. [optional]
o_generation_id str GenerationID is the generation Id for the object. This is incremented anytime there is an update to the user intent, including Spec update and any update to ObjectMeta. System generated and updated, not updatable by user. [optional]
o_resource_version str Resource version in the object store. This is updated anytime there is any change to the object. System generated and updated, not updatable by user. [optional]
o_uuid str UUID is the unique identifier for the object. This is generated on creation of the object. System generated, not updatable by user. [optional]
o_creation_time datetime CreationTime is the creation time of the object. System generated and updated, not updatable by user. [optional]
o_mod_time datetime ModTime is the Last Modification time of the object. System generated and updated, not updatable by user. [optional]
o_self_link str SelfLink is a link for accessing this object. When the object is served from the API-GW it is the URI path. Example: - "/v1/tenants/tenants/tenant2" System generated and updated, not updatable by user. [optional]
label_selector str LabelSelector to select on labels in list or watch results. [optional]
field_selector str FieldSelector to select on field values in list or watch results. [optional]
field_change_selector [str] FieldChangeSelector specifies to generate a watch notification on change in field(s) specified. [optional]
_from int From represents the start index number (1 based - first object starts from index 1), of the results list. The results returned would be in the range [from ... (from + (max-results - 1))]. If From = 0, the server will attempt to return all the results in the list without pagination. [optional]
max_results int MaxResults is the maximum number of results to be returned as part of the response, per page If MaxResults is more than the maximum number of results per page supported by the server, the server will return an err If MaxResults is 0, the server will return all the results without pagination. [optional]
sort_order str order to sort List results in. [optional]
meta_only bool If MetaOnly is set to true, the watch event notification that matches the watch criteria will not contain the full object. It will only contain the information about the object that changed, i.e. which object and what changed. MetaOnly is not set by default. [optional]

Return type

DiagnosticsAutoMsgModuleWatchHelper

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 (streaming responses) -
400 Bad request parameters -
401 Unauthorized request -
409 Conflict while processing request -
412 Pre-condition failed -
500 Internal server error -
501 Request not implemented -

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