REST API for Unified Assurance Microservices

Rediscover Devices

post

/rediscovery

Rediscovers the devices for the current configuration.

Request

There are no request parameters for this operation.

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

Data: object Data

The rediscovery data.
Type: string

Allowed Values: [ "rediscovery" ]

The request type.
Version: string

The rediscovery version.

Example: 1.0.0

{
    "type":"object",
    "properties":{
        "Type":{
            "description":"The request type.",
            "type":"string",
            "enum":[
                "rediscovery"
            ]
        },
        "Version":{
            "description":"The rediscovery version.",
            "type":"string",
            "example":"1.0.0"
        },
        "Data":{
            "description":"The rediscovery data.",
            "type":"object",
            "required":[
                "apiType"
            ],
            "properties":{
                "apiType":{
                    "description":"The type of REST API.",
                    "type":"string",
                    "enum":[
                        "vmware"
                    ]
                },
                "Configuration":{
                    "type":"object",
                    "properties":{
                        "ContextExpiryTimeM":{
                            "description":"The number of minutes the discovery is valid before it gets expired.",
                            "type":"integer",
                            "minimum":"0",
                            "maximum":"2147483647",
                            "example":"60"
                        },
                        "IncludedProtocols":{
                            "description":"Type of polling enabled for discovery. Possible values are <b>1</b> for ping, <b>2</b> for SNMP, and <b>3</b> for REST.",
                            "type":"array",
                            "items":{
                                "type":"integer",
                                "enum":[
                                    "1",
                                    "2",
                                    "3"
                                ],
                                "example":"1, 2, 3"
                            }
                        }
                    }
                },
                "IPList":{
                    "description":"The list of IP addresses.",
                    "type":"array",
                    "items":{
                        "type":"string"
                    },
                    "example":[
                        "192.0.2.0",
                        "192.0.2.1"
                    ]
                },
                "InventoryEngine":{
                    "description":"The inventory engine name.",
                    "type":"string",
                    "example":"inventory-engine-name"
                }
            }
        }
    }
}

Nested Schema : Data

Type: object

The rediscovery data.

Show Source

apiType(required): string

Allowed Values: [ "vmware" ]

The type of REST API.
Configuration: object Configuration
InventoryEngine: string

The inventory engine name.

Example: inventory-engine-name
IPList: array IPList

The list of IP addresses.

{
    "description":"The rediscovery data.",
    "type":"object",
    "required":[
        "apiType"
    ],
    "properties":{
        "apiType":{
            "description":"The type of REST API.",
            "type":"string",
            "enum":[
                "vmware"
            ]
        },
        "Configuration":{
            "type":"object",
            "properties":{
                "ContextExpiryTimeM":{
                    "description":"The number of minutes the discovery is valid before it gets expired.",
                    "type":"integer",
                    "minimum":"0",
                    "maximum":"2147483647",
                    "example":"60"
                },
                "IncludedProtocols":{
                    "description":"Type of polling enabled for discovery. Possible values are <b>1</b> for ping, <b>2</b> for SNMP, and <b>3</b> for REST.",
                    "type":"array",
                    "items":{
                        "type":"integer",
                        "enum":[
                            "1",
                            "2",
                            "3"
                        ],
                        "example":"1, 2, 3"
                    }
                }
            }
        },
        "IPList":{
            "description":"The list of IP addresses.",
            "type":"array",
            "items":{
                "type":"string"
            },
            "example":[
                "192.0.2.0",
                "192.0.2.1"
            ]
        },
        "InventoryEngine":{
            "description":"The inventory engine name.",
            "type":"string",
            "example":"inventory-engine-name"
        }
    }
}

Nested Schema : Configuration

Type: object

Show Source

ContextExpiryTimeM: integer

Minimum Value: 0

Maximum Value: 2147483647

The number of minutes the discovery is valid before it gets expired.

Example: 60
IncludedProtocols: array IncludedProtocols

Type of polling enabled for discovery. Possible values are 1 for ping, 2 for SNMP, and 3 for REST.

{
    "type":"object",
    "properties":{
        "ContextExpiryTimeM":{
            "description":"The number of minutes the discovery is valid before it gets expired.",
            "type":"integer",
            "minimum":"0",
            "maximum":"2147483647",
            "example":"60"
        },
        "IncludedProtocols":{
            "description":"Type of polling enabled for discovery. Possible values are <b>1</b> for ping, <b>2</b> for SNMP, and <b>3</b> for REST.",
            "type":"array",
            "items":{
                "type":"integer",
                "enum":[
                    "1",
                    "2",
                    "3"
                ],
                "example":"1, 2, 3"
            }
        }
    }
}

Nested Schema : IPList

Type: array

The list of IP addresses.

Show Source

Array of: string

{
    "description":"The list of IP addresses.",
    "type":"array",
    "items":{
        "type":"string"
    },
    "example":[
        "192.0.2.0",
        "192.0.2.1"
    ]
}

Example:

[
    "192.0.2.0",
    "192.0.2.1"
]

Nested Schema : IncludedProtocols

Type: array

Type of polling enabled for discovery. Possible values are 1 for ping, 2 for SNMP, and 3 for REST.

Show Source

Array of: integer

Allowed Values: [ "1", "2", "3" ]

Example: 1, 2, 3

{
    "description":"Type of polling enabled for discovery. Possible values are <b>1</b> for ping, <b>2</b> for SNMP, and <b>3</b> for REST.",
    "type":"array",
    "items":{
        "type":"integer",
        "enum":[
            "1",
            "2",
            "3"
        ],
        "example":"1, 2, 3"
    }
}

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : DiscoveryCreateResponse

Type: object

Show Source

DiscoveryContextID: string

The ID obtained from discovery request.

Example: disco-01f107bd-655f-42e0-ae1c-ac4740e734e7
time-valid: integer

The number of seconds the discovery result is valid.

Example: 3600

{
    "type":"object",
    "properties":{
        "DiscoveryContextID":{
            "description":"The ID obtained from discovery request.",
            "type":"string",
            "example":"disco-01f107bd-655f-42e0-ae1c-ac4740e734e7"
        },
        "time-valid":{
            "description":"The number of seconds the discovery result is valid.",
            "type":"integer",
            "example":"3600"
        }
    }
}

401 Response

Unauthorized operation

405 Response

Bad request

500 Response

Internal server error