Class ManagementAgent
The details of the Management Agent inventory including the associated plugins.
Inherited Members
Namespace: Oci.ManagementagentService.Models
Assembly: OCI.DotNetSDK.Managementagent.dll
Syntax
public class ManagementAgentProperties
AvailabilityStatus
Declaration
[JsonProperty(PropertyName = "availabilityStatus")]
[JsonConverter(typeof(ResponseEnumConverter))]
public AvailabilityStatus? AvailabilityStatus { get; set; }Property Value
| Type | Description |
|---|---|
| AvailabilityStatus? | The current availability status of managementAgent |
CompartmentId
Declaration
[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }Property Value
| Type | Description |
|---|---|
| string | Compartment Identifier |
Remarks
Required
DataSourceList
Declaration
[JsonProperty(PropertyName = "dataSourceList")]
public List<DataSource> DataSourceList { get; set; }Property Value
| Type | Description |
|---|---|
| List<DataSource> | list of dataSources associated with the agent |
DefinedTags
Declaration
[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }Property Value
| Type | Description |
|---|---|
| Dictionary<string, Dictionary<string, object>> | Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} |
DisplayName
Declaration
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }Property Value
| Type | Description |
|---|---|
| string | Management Agent Name |
FreeformTags
Declaration
[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }Property Value
| Type | Description |
|---|---|
| Dictionary<string, string> | Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"} |
Host
Declaration
[JsonProperty(PropertyName = "host")]
public string Host { get; set; }Property Value
| Type | Description |
|---|---|
| string | Management Agent host machine name |
HostId
Declaration
[JsonProperty(PropertyName = "hostId")]
public string HostId { get; set; }Property Value
| Type | Description |
|---|---|
| string | Host resource ocid |
Id
Declaration
[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }Property Value
| Type | Description |
|---|---|
| string | agent identifier |
Remarks
Required
InstallKeyId
Declaration
[JsonProperty(PropertyName = "installKeyId")]
public string InstallKeyId { get; set; }Property Value
| Type | Description |
|---|---|
| string | agent install key identifier |
InstallPath
Declaration
[JsonProperty(PropertyName = "installPath")]
public string InstallPath { get; set; }Property Value
| Type | Description |
|---|---|
| string | Path where Management Agent is installed |
InstallType
Declaration
[JsonProperty(PropertyName = "installType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public InstallTypes? InstallType { get; set; }Property Value
| Type | Description |
|---|---|
| InstallTypes? | The install type, either AGENT or GATEWAY |
IsAgentAutoUpgradable
Declaration
[JsonProperty(PropertyName = "isAgentAutoUpgradable")]
public bool? IsAgentAutoUpgradable { get; set; }Property Value
| Type | Description |
|---|---|
| bool? | true if the agent can be upgraded automatically; false if it must be upgraded manually. This flag is derived from the tenancy level auto upgrade preference. |
IsCustomerDeployed
Declaration
[JsonProperty(PropertyName = "isCustomerDeployed")]
public bool? IsCustomerDeployed { get; set; }Property Value
| Type | Description |
|---|---|
| bool? | true, if the agent image is manually downloaded and installed. false, if the agent is deployed as a plugin in Oracle Cloud Agent. |
LifecycleDetails
Declaration
[JsonProperty(PropertyName = "lifecycleDetails")]
public string LifecycleDetails { get; set; }Property Value
| Type | Description |
|---|---|
| string | A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. |
LifecycleState
Declaration
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public LifecycleStates? LifecycleState { get; set; }Property Value
| Type | Description |
|---|---|
| LifecycleStates? | The current state of managementAgent |
ManagementAgentProperties
Declaration
[JsonProperty(PropertyName = "managementAgentProperties")]
public List<ManagementAgentProperty> ManagementAgentProperties { get; set; }Property Value
| Type | Description |
|---|---|
| List<ManagementAgentProperty> | Additional properties for this Management Agent |
PlatformName
Declaration
[JsonProperty(PropertyName = "platformName")]
public string PlatformName { get; set; }Property Value
| Type | Description |
|---|---|
| string | Platform Name |
PlatformType
Declaration
[JsonProperty(PropertyName = "platformType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public PlatformTypes? PlatformType { get; set; }Property Value
| Type | Description |
|---|---|
| PlatformTypes? | Platform Type |
PlatformVersion
Declaration
[JsonProperty(PropertyName = "platformVersion")]
public string PlatformVersion { get; set; }Property Value
| Type | Description |
|---|---|
| string | Platform Version |
PluginList
Declaration
[JsonProperty(PropertyName = "pluginList")]
public List<ManagementAgentPluginDetails> PluginList { get; set; }Property Value
| Type | Description |
|---|---|
| List<ManagementAgentPluginDetails> | list of managementAgentPlugins associated with the agent |
ResourceArtifactVersion
Declaration
[JsonProperty(PropertyName = "resourceArtifactVersion")]
public string ResourceArtifactVersion { get; set; }Property Value
| Type | Description |
|---|---|
| string | Version of the deployment artifact instantiated by this Management Agent. The format for Standalone resourceMode is YYMMDD.HHMM, and the format for other modes (whose artifacts are based upon Standalone but can advance independently) is YYMMDD.HHMM.VVVVVVVVVVVV. VVVVVVVVVVVV is always a numeric value between 000000000000 and 999999999999 |
SystemTags
Declaration
[JsonProperty(PropertyName = "systemTags")]
public Dictionary<string, Dictionary<string, object>> SystemTags { get; set; }Property Value
| Type | Description |
|---|---|
| Dictionary<string, Dictionary<string, object>> | Usage of system tag keys. These predefined keys are scoped to namespaces. Example: { "orcl-cloud": { "free-tier-retained": "true" } } |
TimeCreated
Declaration
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }Property Value
| Type | Description |
|---|---|
| DateTime? | The time the Management Agent was created. An RFC3339 formatted datetime string |
TimeLastHeartbeat
Declaration
[JsonProperty(PropertyName = "timeLastHeartbeat")]
public DateTime? TimeLastHeartbeat { get; set; }Property Value
| Type | Description |
|---|---|
| DateTime? | The time the Management Agent has last recorded its health status in telemetry. This value will be null if the agent has not recorded its health status in last 7 days. An RFC3339 formatted datetime string |
TimeUpdated
Declaration
[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }Property Value
| Type | Description |
|---|---|
| DateTime? | The time the Management Agent was updated. An RFC3339 formatted datetime string |
Version
Declaration
[Required(ErrorMessage = "Version is required.")]
[JsonProperty(PropertyName = "version")]
public string Version { get; set; }Property Value
| Type | Description |
|---|---|
| string | Management Agent Version |
Remarks
Required