|
APIs in Category: Networks |
API version 5.0 |
DfmNetworkAdd |
DFM discovers the network specifed through these apis. |
| DfmNetworkAdd (supported) | [top] |
Adds a network in DFM To discover.
Input Name Type DfmNetworkAdd DfmNetworkAdd
Output Name Type DfmNetworkAddResult DfmNetworkAddResult
Error Name Description EACCESSDENIED EAPIERROR EDATABASEERROR EINTERNALERROR EINVALIDINPUT
| DfmNetworkDelete (supported) | [top] |
Delete a network From DFM so that discovery is disabled for that network. Either NetworkId or NetworkAddress has To be provided. If both are specified then an Error(EINVALIDINPUT) will be thrown.
Input Name Type DfmNetworkDelete DfmNetworkDelete
Output Name Type DfmNetworkDeleteResult DfmNetworkDeleteResult
Error Name Description EACCESSDENIED EAPIERROR EDATABASEERROR EINTERNALERROR EINVALIDINPUT
| DfmNetworkListInfo (supported) | [top] |
Returns list of Networks added To DFM for discovery.
Input Name Type DfmNetworkListInfo DfmNetworkListInfo
Output Name Type DfmNetworkListInfoResult DfmNetworkListInfoResult
Error Name Description EACCESSDENIED EAPIERROR EDATABASEERROR EINTERNALERROR EINVALIDINPUT
| DfmNetworkModify (supported) | [top] |
Modify prefix Length of a network in DFM, so that Host discovery in this Networks should happen based on new subnet mask derived From new Value of prefix Length.
Input Name Type DfmNetworkModify DfmNetworkModify
Output Name Type DfmNetworkModifyResult DfmNetworkModifyResult
Error Name Description EACCESSDENIED EAPIERROR EDATABASEERROR EINTERNALERROR EINVALIDINPUT
| Element definition: DfmNetworkAdd | [top] |
Adds a network in DFM To discover.
Name Type Description NetworkAddress NetworkAddress
IP Address of the network To be added. PrefixLength PrefixLength
The routing prefix Length of the network. Useful for calculation of subnet mask of a network.
| Element definition: DfmNetworkAddResult | [top] |
Name Type Description NetworkId NetworkId
A unique-identifier of the newly added network in DFM.
| Element definition: DfmNetworkDelete | [top] |
Delete a network From DFM so that discovery is disabled for that network. Either NetworkId or NetworkAddress has To be provided. If both are specified then an Error(EINVALIDINPUT) will be thrown.
Name Type Description NetworkAddress NetworkAddress
optional
IP Address of network. NetworkId ObjId
optional
Unique identifier of the network in DFM.
| Element definition: DfmNetworkDeleteResult | [top] |
[none]
| Element definition: DfmNetworkListInfo | [top] |
Returns list of Networks added To DFM for discovery.
Name Type Description NetworkId NetworkId
optional
Unique identifier representing a network in DFM. If no input is provided, then information about all the Networks added To DFM for discovery will be returned.
| Element definition: DfmNetworkListInfoResult | [top] |
Name Type Description Networks ArrayOfNetworkInfo
The list of Networks.
| Element definition: DfmNetworkModify | [top] |
Modify prefix Length of a network in DFM, so that Host discovery in this Networks should happen based on new subnet mask derived From new Value of prefix Length.
Name Type Description NetworkId NetworkId
Unique identifier of the network in DFM. PrefixLength PrefixLength
New routing prefix Length of network.
| Element definition: DfmNetworkModifyResult | [top] |
[none]
| Element definition: ArrayOfNetworkInfo | [top] |
Name Type Description NetworkInfo NetworkInfo[]
| Element definition: NetworkAddress | [top] |
IP Address of the network or Host
[none]
| Element definition: NetworkId | [top] |
Unique Id representing network in DFM. Range: [0..2^31-1]
[none]
| Element definition: ObjId | [top] |
Identification number (ID) for a DFM object. This typedef is an alias for the builtin ZAPI Type integer. Object IDs are unsigned integers in the range [1..2^31 - 1]. In some contexts, an object ID is also allowed To be 0, which is interpreted as a null Value, e.g., a reference To no object at all. The ID for a DFM object is always assigned by the system; the user is never allowed To assign an ID To an object. Therefore, an input element of Type ObjId is always used To refer To an existing object by its ID. The ZAPI must specify the object's DFM object Type (e.g. Dataset, Host, DP Policy, etc.). Some ZAPIs allow the object To be one of several different types.
If the Value of an ObjId input element does not Match the ID of any existing DFM object of the specified Type or types, then typically the ZAPI fails with Error code EOBJECTNOTFOUND. A ZAPI may deviate From this general rule, for example, it may return a more specific Error code. In either case, the ZAPI specification must document its behavior.
[none]
| Element definition: PrefixLength | [top] |
Prefix Length of the network or Host
[none]
| Element definition: NetworkInfo | [top] |
Information of one network.
Name Type Description HopCount xsd:integer
Represents hop Count for the network. Zero will be returned if network is not discovered. Range: [0..2^31 -1] LastSearchedTime Timestamp
optional
Represents the time when network was last discovered. Value is the time in seconds since 00:00:00 Jan 1, 1970, UTC. NetworkAddress NetworkAddress
Address of the network. NetworkId NetworkId
A unique Id representing the network. PrefixLength PrefixLength
The routing prefix Length of the network.
| Element definition: Timestamp | [top] |
Seconds since 1/1/1970 in UTC. Range: [0..2^31-1].
[none]