ConnectTest
Description
An object that checks the connectivity to a specific destination through a specified interface. If no interface is specified, the connectivity test will be invoked without an interface and routed through the default interface on the device. (Note: The field level constraints listed here might not cover all the constraints on the field. Additional constraints might exist.)
Supported Operations
Model Properties
| Property | Required | Type | Description | |||
|---|---|---|---|---|---|---|
| destination | True | string | An optional string that specifies the destination to test. The default is www.cisco.com. You can enter an IPv4 address or a fully-qualified domain name. Field level constraints: cannot be null, must be a valid host (FQDN or IP) or a list of valid hosts. (Note: Additional constraints might exist) |
|||
| connected | False | boolean | A boolean value, TRUE or FALSE (the default). The TRUE value specifies that the connection is established. FALSE indicates the connection is not established. | |||
| msg | False | string | A string representing the message when the connection fails. | |||
| id | False | string | A unique string identifier assigned by the system when the object is created. No assumption can be made on the format or content of this identifier. The identifier must be provided whenever attempting to modify/delete (or reference) an existing object. Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist) |
|||
| interface | False | object | An interface object through which connectivity to a specific destination would be tested. Allowed types are: [BridgeGroupInterface, EtherChannelInterface, PhysicalInterface, SubInterface, VirtualTunnelInterface, VlanInterface] |
|||
| type | True | string | A UTF8 string, all letters lower-case, that represents the class-type. This corresponds to the class name. | |||