Agency Add Issue

Agency Add Issue

Deprecated.

Adds an issue to this agency.

key and time is overwritten so that key becomes unique on this server and time is the current time.

Requires modify privileges.

Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/eam/Agency/{moId}/AddIssue
COPY
Path Parameters
string
moId
Required

The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId, in this case Agency/{moId}.

string
release
Required

The vSphere release schema. The current specification covers vSphere 8.0.3.0 APIs.


Request Body
AddIssueRequestType of type(s) application/json
Required

Show optional properties

{
    "issue": {
        "key": 0,
        "description": "string",
        "time": "string"
    }
}
{
    "issue": {
        "_typeName": "string",
        "key": 0,
        "description": "string",
        "time": "string"
    }
}
issue
Required

An issue represents a problem encountered while deploying and configurating agents in a vCenter installation.

An issue conveys the type of problem and the entitity on which the problem has been encountered. Most issues are related to agents, but they can also relate to an agency or a host.

The set of issues provided by the vSphere ESX Agent Manager describes the discrepency between the desired agent deployment state, as defined by the agency configurations, and the actual deployment. The (@link EamObject.RuntimeInfo.Status.status) of an agency or agent is green if it has reached its goal state. It is marked as yellow if the vSphere ESX Agent Manager is actively working to bring the object to its goal state. It is red if there is a discrepency between the current state and the desired state. In the red state, a set of issues are filed on the object that describe the reason for the discrepency between the desired and actual states.

Issues are characterized as either active or passive remediable issues. For an active remediable issue, the vSphere ESX Agent Manager can actively try to solve the issue. For example, by deploying a new agent, removing an agent, changing its power state, and so on. For a passive remediable issue, the vSphere ESX Agent Manager is not able to solve the problem directly, and can only report the problem. For example, this could be caused by an incomplete host configuration.

When resolve is called for an active remediable issue, the vSphere ESX Agent Manager starts performing the appropiate remediation steps for the particular issue. For a passive remediable issue, the EAM manager simply checks if the condition still exists, and if not it removes the issue.

The vSphere ESX Agent Manager actively monitors most conditions relating to both active and passive issues. Thus, it often automatically discovers when an issue has been remediated and removes the issue without needing to explicitly call resolve on an issue.

The complete Issue hierarchy is shown below:

See also Resolve, ResolveAll.

This structure may be used only with operations rendered under /eam.

Authentication
This operation uses the following authentication methods.
Responses
200

The same issue where the key and time is set.

Returns Issue of type(s) application/json
This response body class contains all of the following: DataObject
{
    "_typeName": "string",
    "key": 0,
    "description": "string",
    "time": "string"
}
integer As int32 As int32
key
Required

A unique identifier per Issue instance.

string
description
Required

A localized message describing the issue.

string As date-time As date-time
time
Required

The point in time when this issue was generated.

Note that issues can be regenerated periodically, so this time does not neccessarily reflect the first time the issue was detected.


500

InvalidArgument: Thrown if issue typeId is unknown.

Returns InvalidArgument of type(s) application/json
This response body class contains all of the following: RuntimeFault
{
    "_typeName": "string",
    "faultCause": "MethodFault Object",
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ],
    "invalidProperty": "string"
}
string
invalidProperty
Optional

Optional name of the invalid property.