Jump to

• Request
• Response

Rediscover Devices

post

/api/app/discovery/{zoneid}/v2/devices/rediscover

Rediscovers the devices for the current configuration.

Request

Path Parameters

• zoneid(required): string
  The ID for the zone in which the Discovery Service is deployed.

Supported Media Types

• application/json

Request Body - 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 rediscovery. Possible values are <b>1</b> for ping, <b>2</b> for the shared SNMP and gNMI protocol, and <b>3</b> for REST. Use <b>IncludedMethods</b> with level <b>2</b> to choose SNMP, gNMI, or both.",
                            "type":"array",
                            "items":{
                                "type":"integer",
                                "enum":[
                                    1,
                                    2,
                                    3
                                ],
                                "example":"1, 2, 3"
                            }
                        },
                        "IncludedMethods":{
                            "description":"Methods enabled for shared rediscovery level <b>2</b>. Possible values are <b>snmp</b> and <b>gnmi</b>. Defaults to <b>snmp</b> when omitted. This field is supported only by the v2 rediscovery endpoint.",
                            "type":"array",
                            "items":{
                                "type":"string",
                                "enum":[
                                    "snmp",
                                    "gnmi"
                                ]
                            },
                            "example":[
                                "snmp",
                                "gnmi"
                            ]
                        }
                    }
                },
                "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"
                },
                "TenantID":{
                    "description":"Rediscovery for TenantID. Optional.",
                    "type":"integer",
                    "example":1
                },
                "autoMonitor":{
                    "description":"Set this to complete rediscovery automatically.",
                    "type":"boolean",
                    "example":false
                }
            }
        }
    }
}

Nested Schema : Data

Type: object

The rediscovery data.

Show Source

• apiType(required): string
  Allowed Values: [ "vmware" ]

  The type of REST API.
• autoMonitor: boolean
  Set this to complete rediscovery automatically.

  Example: false
• Configuration: object Configuration
• InventoryEngine: string
  The inventory engine name.

  Example: inventory-engine-name
• IPList: array IPList
  The list of IP addresses.
• TenantID: integer
  Rediscovery for TenantID. Optional.

  Example: 1

{
    "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 rediscovery. Possible values are <b>1</b> for ping, <b>2</b> for the shared SNMP and gNMI protocol, and <b>3</b> for REST. Use <b>IncludedMethods</b> with level <b>2</b> to choose SNMP, gNMI, or both.",
                    "type":"array",
                    "items":{
                        "type":"integer",
                        "enum":[
                            1,
                            2,
                            3
                        ],
                        "example":"1, 2, 3"
                    }
                },
                "IncludedMethods":{
                    "description":"Methods enabled for shared rediscovery level <b>2</b>. Possible values are <b>snmp</b> and <b>gnmi</b>. Defaults to <b>snmp</b> when omitted. This field is supported only by the v2 rediscovery endpoint.",
                    "type":"array",
                    "items":{
                        "type":"string",
                        "enum":[
                            "snmp",
                            "gnmi"
                        ]
                    },
                    "example":[
                        "snmp",
                        "gnmi"
                    ]
                }
            }
        },
        "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"
        },
        "TenantID":{
            "description":"Rediscovery for TenantID. Optional.",
            "type":"integer",
            "example":1
        },
        "autoMonitor":{
            "description":"Set this to complete rediscovery automatically.",
            "type":"boolean",
            "example":false
        }
    }
}

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
• IncludedMethods: array IncludedMethods
  Methods enabled for shared rediscovery level 2. Possible values are snmp and gnmi. Defaults to snmp when omitted. This field is supported only by the v2 rediscovery endpoint.
• IncludedProtocols: array IncludedProtocols
  Type of polling enabled for rediscovery. Possible values are 1 for ping, 2 for the shared SNMP and gNMI protocol, and 3 for REST. Use IncludedMethods with level 2 to choose SNMP, gNMI, or both.

{
    "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 rediscovery. Possible values are <b>1</b> for ping, <b>2</b> for the shared SNMP and gNMI protocol, and <b>3</b> for REST. Use <b>IncludedMethods</b> with level <b>2</b> to choose SNMP, gNMI, or both.",
            "type":"array",
            "items":{
                "type":"integer",
                "enum":[
                    1,
                    2,
                    3
                ],
                "example":"1, 2, 3"
            }
        },
        "IncludedMethods":{
            "description":"Methods enabled for shared rediscovery level <b>2</b>. Possible values are <b>snmp</b> and <b>gnmi</b>. Defaults to <b>snmp</b> when omitted. This field is supported only by the v2 rediscovery endpoint.",
            "type":"array",
            "items":{
                "type":"string",
                "enum":[
                    "snmp",
                    "gnmi"
                ]
            },
            "example":[
                "snmp",
                "gnmi"
            ]
        }
    }
}

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 : IncludedMethods

Type: array

Methods enabled for shared rediscovery level 2. Possible values are snmp and gnmi. Defaults to snmp when omitted. This field is supported only by the v2 rediscovery endpoint.

Show Source

• Array of: string
  Allowed Values: [ "snmp", "gnmi" ]

{
    "description":"Methods enabled for shared rediscovery level <b>2</b>. Possible values are <b>snmp</b> and <b>gnmi</b>. Defaults to <b>snmp</b> when omitted. This field is supported only by the v2 rediscovery endpoint.",
    "type":"array",
    "items":{
        "type":"string",
        "enum":[
            "snmp",
            "gnmi"
        ]
    },
    "example":[
        "snmp",
        "gnmi"
    ]
}

Example:

[
    "snmp",
    "gnmi"
]

Nested Schema : IncludedProtocols

Type: array

Type of polling enabled for rediscovery. Possible values are 1 for ping, 2 for the shared SNMP and gNMI protocol, and 3 for REST. Use IncludedMethods with level 2 to choose SNMP, gNMI, or both.

Show Source

• Array of: integer
  Allowed Values: [ 1, 2, 3 ]

  Example: 1, 2, 3

{
    "description":"Type of polling enabled for rediscovery. Possible values are <b>1</b> for ping, <b>2</b> for the shared SNMP and gNMI protocol, and <b>3</b> for REST. Use <b>IncludedMethods</b> with level <b>2</b> to choose SNMP, gNMI, or both.",
    "type":"array",
    "items":{
        "type":"integer",
        "enum":[
            1,
            2,
            3
        ],
        "example":"1, 2, 3"
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

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

Back to Top