Telco Cloud Service Assurance Operations Index
All available Telco Cloud Service Assurance Operations
Retrieves high level detail of all existing catalog metrics model with device type and entity type.
Provides details of the metric type model belonging to one/more domain.
Get instantiated blocks and Get information about instantiated blocks
This API is useful for creating a new collector instance of given type( like cisco-aci,vims,kafka-collector )
Get block config and Get configurations for an installed module and instance
Delete a collector
You can start, stop, and restart the collectors start - Collector will start collecting data based on its configuration stop - Collector will stop collecting data restart - is usuful if collector is not working as expected
List the all collectors configuration files. This API can filter the configuration files based on "modules". By default API returns all the backup files, but user can enable/disable via query param "backup_files".
Retrieves the requested configuration file's content.
Updates the requested configuration file's content.
Deletes the requested configuration files.
User can upload configuration files in collector module.
Returns the list of collector modules.
Send file as attachment for download
Get all Datacenter locations for the Kubernetes Stretched Cluster.
Get all collector types such as cisco-aci,kafka-collector,vims and related information
This API is used for cloning the existing user-preference. If the requested "id" is defined as "parent_id" of any other user-preferences then those user-preferences will be also cloned.
This API is used for cloning the existing user-preference. If the requested "id" is defined as "parent_id" of any other user-preferences then those user-preferences will be also cloned.
This API is used for creating a new user-preference configuration.
This API is used for getting user-preferences based on query parameters. If no query parameter is passed then, API will return all available user-preferences for requested user.
This API is used for fetching the details of requested user-preference.
This API is used for deleting the requested user-preference. This API will also delete all the other user-prefereces, which are refering the requested user-preference as "parent".
This API is used for updating the existing user-preference configuration. Update API expects all parameters retrived via get API. Fields "id", "is_predefined" and "created_by" are read-only and can't be updated. Any missing non mandatory field in udpate request, will be set to default values.
List instantiated connectors
Create a connector instance
Get connector instance details
Update the Connector Configuration e.g. number of tasks replicationFactor, add remove topics for replication
Delete a connector
API to start, stop, and restart a connector instance start - connector will start transfering data based on its configuration stop - connector will stop transfering data restart - is usuful if connector is not working as expected
List All Kafka Mapper Configurations
Create a new Kafka Mapper.
Modify an Existing Kafka Mapper Configuration.
Delete the Kafka Mapper Instance
An API for fetching the count of all physical and virtual devices discovered in each domain manager.
pre-requisite
To fetch metric types and metric names details refer Catalog API
To fetch entity name, entity type, device type, and device name refer to Topology API
API to fetch raw metrics for given metric type,entity name, and time range.
This API is used to show the traffic map between the nodes for given link or cable .This api fetches the metrics CurrentUtilization,InputPacketErrorPct for both the ends for given link,cable.Input for this API is id which is combination of A-End <--> Z-End, where A-End,Z-End are entity names on which metrics are getting collected.
Returns the list of notifications. By default maximum 10 records from offset 0 are returned in the response. In order to get the more or less number of records user can specify the desired number of records using "size" parameter.
This API provides summary of notification severity and their count.
This operation extracts the maximum severity value of notifications raised on the requested devices.
Returns the previous records and the occurrence of notification.
Get causes operation lists the impacted notification caused by the requested notification.
Returns the list of notification, that are causing the requested notification.
This API returns the audit trails of the notification.
APIs for performing actions on notifications such as ACKNOWLEDGE, UNACKNOWLEDGE,TAKE_OWNERSHIP AND RELEASE_OWNERSHIP.
Fetches all server tools allowed on requested notification
Executes actions such as "open trouble ticket and close trouble ticket".
This API returns the distinct values of live notifications for a property, provided as query param {property_name}. If user wants to get the distinct values for a set of notification instead of all notification, user can pass filter in the request payload.
This API exports notifications that are matched with given filter to csv file.
Returns the count of notifications that are matching with given filter
Returns the threshold attributes with values and descriptions.
This API is used for adding audit logs for multiple notifications.
This API is used for acknowledge multiple notifications.
This API is used for un-acknowledge multiple notifications.
This API is used to take ownership for multiple notifications.
This API is used for releasing ownership for multiple notifications.
Retrieves all rules from the remediation model.
policy name.
This API is used for updating a remediation rule or policy. Update API expects all parameters retrived via get API. Fields "policy_name", "created_on" and "last_updated" are read-only and can't be updated. Any missing non mandatory field in udpate request, will be set to default values.
This API is used for deleting the requested remediation rule.
This API is used for creating a new remediation rule. Fields "created_on" and "last_updated" are read-only and can't be updated, Any missing non mandatory field in udpate request, will be set to default values.
Retrieves all actions from the remediation model.
This API is used for creating a new remediation action. Name, category are mandatory fields. Fields "created_on" and "last_updated" are read-only and can't be updated.
action name.
This API is used for updating a remediation action. Update API expects all parameters retrived via get API. Fields "action_name", "file_type", "created_on" and "last_updated" are read-only and can't be updated. Any missing non mandatory field in update request, will be set to default values.
This API is used for deleting the requested remediation action.
Retrieves all connections from the remediation model.
This API is used for creating a new remediation connection.
connection name.
This API is used for updating a remediation connection. Update API expects all parameters retrived via get API. Fields "connection_id" is read-only and can't be updated. Any missing non mandatory field in update request, will be set to default values.
This API is used for deleting the requested remediation connection.
This API is used for retrieve the list of remediation rules and actions for a particular notification.
This API is used to trigger execution of a manual remediation rule. Rule name, action name and Notification data should be part of the relevant payload.
Initializes an snmp collector object. This step creates an SNMP Collector with default configuration in the running state. This is only an initialization API any agent/polling group/masks configuration provided will not be applied.
Updates the snmp collector configuration with the configuration provided. This configuration change is not reflected in the running collector. It is stored in an intermediate database, with the status as "NOT_SYNC".
Gets all the snmp collectors created. Deletes those SNMP collectors that do not show up in the collector manager.
Deletes a list of the given snmp collectors. Deleting SNMP collectors also deletes the associated polling groups.
API to send the configuration of the snmp Collectors to the collector manager. On successful completion it changes the state of the collector to IN_SYNC
Gets a single snmp collector based on the id provided
API to check the polling groups associated with the collectors selected. This is used to inform the user about the polling groups affected before deleting a collector.
Creates/modifies an entire snmp integration from start to end. Given all the collectors, agents, masks and polling groups. The integration is created and the collectors are started.
To get the entire configuration of a single snmp integration
API to add a single agent
API to update a single agent
API to get a list of agents.
Deletes a list of agents. In the request body it requires a list of strings, these strings being the agentIds.
API to get a particular agent given an agent ID. The ID is a combination of 4 attributes "ipAddress" , "port", "contextName" and "contextEnginedId"
API to check the polling groups associated with the agents selected. This is to check the agents before deleting them
This API performs two functions:
- Discovers capabilities on all agents.
- Distributes agents to collectors and generates polling groups based on the capabilities discovered. Note: A call to this API might re-distribute an agent to another collector. In order to avoid this, a specific collector can be provided while adding the agent in the "collectorName" field. In doing so the agent will always be assigned to the same collector.
API to download the all the agents. Agents can be downloaded in csv format or tab separated format. These downloaded files can be used for upload.
API to cancel discovery of capabilities on agents. This API will cancel the discovery of agents and the agents won't be re-distributed.
A Seed file can be uploaded in two formats, a comma separated file, or a tab separated file.
CSV - The user can provide csv files of three different syntaxes
- Basic Agent - ipAddress, name
- Standard agent - ipAddress, name, snmpCommunityOrUserV3Name, snmpPort, snmpVersion, [collectorName, pollingPeriod, capability, doNotDiscoverCapability]
- Full agent - name, ipAddress, snmpPort, transportProtocol, timeout, retries, snmpVersion, snmpCommunityOrUserV3Name, snmpV3AuthenticationProtocol, snmpV3AuthenticationPassword, snmpV3PrivacyProtocol, snmpV3PrivacyPassword, devtype, onFailTryWith, [collectorName, pollingPeriod, capability, doNotDiscoverCapability]
TAB - The user can provide a tab separated '.txt' file with key value pairs of the attributes. For example-
- name=name1 snmpPort=161 devtype=Router ipAddress=192.168.0.1 capability=ipsla snmpCommunityOrUserV3Name=commString1 collectorName=snmp-collector For providing multiple collectorNames or capabilities two formats are supported a. Space separated values. example - collectorName=collector-a collector-b b. Duplicated keys. example - collectorName=collector-a colectorName=collector-b The keys supported are specified in the VMware docs TCSA web page.
The attributes enclosed in [] are non-mandatory attributes and can be skipped.
API to upload a seed file containing masks and actions. Only files of ".xml" type are accepted
API to add a single mask
API to update a single mask
API to get a list of masks.
Deletes a list of masks. In the request body it requires a list of strings, these strings being the names of the masks.
API to get a particular mask given the mask name.
API to check the polling groups associated with the masks selected. This is to check the masks before deleting them
API to upload a seed file containing translations. Only files of ".xml" type are accepted
API to get a list of translations
API to uplaod a mib file. Files with the same name are over-written
API to get all the mib files uploaded. These include the default MIBs as well
API to upload a seed file containing a single action. Only files of ".xml" type are accepted. To upload an Snmp Action its corresponding mask must exist. If the mask does not exist then an error is thrown.
API to get a list of actions.
API to get a particular action given the name.
API to add a single polling group
API to update a single polling group
API to get a list of polling groups.
Deletes a list of pollingGroups. In the request body it requires a list of strings, these strings being the polling groups names.
API to get a particular pollingGroup given the pollingGroup name.
This API enables user to create task.
This API retrieves all the tasks and also provides ability to filter tasks based on filter criteria.
This API enables user to update the existing task.
This API retrieves the specific tasks using id.
This operation lists or finds Alarm entities How to apply filter: The filtering mechanism is implemented in the query of the URL itself. However there is no specific query parameter named 'filter'.
The filtering is based on using name value query parameters on entity attributes. The basic expression is a sequence of attribute assertions being ANDED to formulate a filtering expression:
- GET {apiRoot} /{resourceName}?[{attributeName}={attributeValue}&*]
For examples:
- GET /tcsa/api/tmf/v1/alarms?ackState=ACKNOWLEDGED&alarmRaisedTime=2022-09-14T04:56:08Z
Here the the filter applied specifies that the alarms returned should have its ackState as ACKNOWLEDGED and should have been raised on 022-09-14T04:56:08Z.
The above mechanism is only for attribute value equality. Attribute values ORING is supported and is achieved by providing a filtering expression where the same attribute name is duplicated a number of times with different values. For example:
- GET /tcsa/api/tmf/v1/alarms?ackState=ACKNOWLEDGED&ackState=UNACKNOWLEDGED
Here the filter applied specifies that the alarms returned should have ackState as either ACKNOWLEDGED or UNACKNOWLEDGED.
Alternatively ORING can also be achieved by comma separating the attribute values. [{attributeName}={attributeValue},{ attributeValue }*]. For example:
- GET /tcsa/api/tmf/v1/alarms?ackState=ACKNOWLEDGED,UNACKNOWLEDGED
This operation creates an Alarm entity.
This operation retrieves an Alarm entity. Attribute selection is enabled for all first level attributes.
This operation deletes an Alarm entity.
This operation updates partially, an Alarm entity.
This operation lists or finds AckAlarms entities
This operation creates an AckAlarms entity.
This operation retrieves an AckAlarms entity. Attribute selection is enabled for all first level attributes.
This operation lists or finds UnAckAlarms entities
This operation creates an UnAckAlarms entity.
This operation retrieves an UnAckAlarms entity. Attribute selection is enabled for all first level attributes.
This operation lists or finds ClearAlarms entities
This operation creates a ClearAlarms entity.
This operation retrieves a ClearAlarms entity. Attribute selection is enabled for all first level attributes.
This operation lists or finds CommentAlarms entities
This operation creates a CommentAlarms entity.
This operation retrieves a CommentAlarms entity. Attribute selection is enabled for all first level attributes.
Get discovered topology class types such as Router, switch, VEdge etc.
Get all supported map types for the given className and instance.
Get all the instances for the given class
Get all the relationships for the given instance
Returns the list of nodes and edges for given class name and instance.
Get the details of the domain manager, which is responsible for discovering the requested topology instance.
This API is used to create a new user federation configuration for LDAP and Active Directory servers.
Retrieves all configured user-federations.
Retrieve the details of requested user federation.
Delete the requested user federation configuration.
Update the requested user federation configuration. This operation expects full object for updation. Missing parameters will be set to default values. Parameter "id" is read only.
Partially Update the requested user federation configuration. This request doesn't requires full object for update, individual object params can be updated.
This API can be used to test the connectivity as well as autheticity of the LDAP server.
This API is used to get all user-federation configuration.
This API is used to create user-federation configuration.
This API is used to retrieve user-federation configuration.
This API is used to delete user-federation configuration.
This API is used to update user-federation configuration.
This API is used to retrieve user-federation configuration.
This API is used to remove imported user from user-federation configuration.
This API is used to unlink users from user-federation configuration.
Retrieves all Get all user groups which includes groups from keycloak as well as AD user groups.
This API enables user to create a webhook subscription for receiving notifications.
This API list all webhook subscription.
This API enables user to update the existing webhook subscription.
This API retrieves the specific webhooks subscription details using id.
This API deletes the specific webhooks subscription.