oci.ManagementAgent.getManagementAgents

func GetManagementAgents(ctx *Context, args *GetManagementAgentsArgs, opts ...InvokeOption) (*GetManagementAgentsResult, error)
func GetManagementAgentsOutput(ctx *Context, args *GetManagementAgentsOutputArgs, opts ...InvokeOption) GetManagementAgentsResultOutput

> Note: This function is named GetManagementAgents in the Go SDK.

CompartmentId string

The OCID of the compartment to which a request will be scoped.

AccessLevel string

When the value is "ACCESSIBLE", insufficient permissions for a compartment will filter out resources in that compartment without rejecting the request.

AvailabilityStatus string

Filter to return only Management Agents in the particular availability status.

CompartmentIdInSubtree bool

if set to true then it fetches resources for all compartments where user has access to else only on the compartment specified.

DataSourceNames List<string>

Unique name of the dataSource.

DataSourceType string

The type of the dataSource.

DisplayName string

Filter to return only Management Agents having the particular display name.

Filters List<GetManagementAgentsFilter>

GatewayIds List<string>

Filter to return only results having the particular gatewayId.

HostId string

Filter to return only Management Agents having the particular agent host id.

InstallType string

A filter to return either agents or gateway types depending upon install type selected by user. By default both install type will be returned.

IsCustomerDeployed bool

true, if the agent image is manually downloaded and installed. false, if the agent is deployed as a plugin in Oracle Cloud Agent.

PlatformTypes List<string>

Array of PlatformTypes to return only results having the particular platform types. Example: ["LINUX"]

PluginNames List<string>

Array of pluginName to return only Management Agents having the particular Plugins installed. A special pluginName of 'None' can be provided and this will return only Management Agents having no plugin installed. Example: ["PluginA"]

State string

Filter to return only Management Agents in the particular lifecycle state.

Versions List<string>

Array of versions to return only Management Agents having the particular agent versions. Example: ["202020.0101","210201.0513"]

WaitForHostId int

When host_id argument is set, the data source will wait for the given period of time (in minutes) for this host_id to become available. This can be used when compute instance with Management Agent has been recently created.

CompartmentId string

The OCID of the compartment to which a request will be scoped.

AccessLevel string

When the value is "ACCESSIBLE", insufficient permissions for a compartment will filter out resources in that compartment without rejecting the request.

AvailabilityStatus string

Filter to return only Management Agents in the particular availability status.

CompartmentIdInSubtree bool

if set to true then it fetches resources for all compartments where user has access to else only on the compartment specified.

DataSourceNames []string

Unique name of the dataSource.

DataSourceType string

The type of the dataSource.

DisplayName string

Filter to return only Management Agents having the particular display name.

Filters []GetManagementAgentsFilter

GatewayIds []string

Filter to return only results having the particular gatewayId.

HostId string

Filter to return only Management Agents having the particular agent host id.

InstallType string

A filter to return either agents or gateway types depending upon install type selected by user. By default both install type will be returned.

IsCustomerDeployed bool

true, if the agent image is manually downloaded and installed. false, if the agent is deployed as a plugin in Oracle Cloud Agent.

PlatformTypes []string

Array of PlatformTypes to return only results having the particular platform types. Example: ["LINUX"]

PluginNames []string

Array of pluginName to return only Management Agents having the particular Plugins installed. A special pluginName of 'None' can be provided and this will return only Management Agents having no plugin installed. Example: ["PluginA"]

State string

Filter to return only Management Agents in the particular lifecycle state.

Versions []string

Array of versions to return only Management Agents having the particular agent versions. Example: ["202020.0101","210201.0513"]

WaitForHostId int

When host_id argument is set, the data source will wait for the given period of time (in minutes) for this host_id to become available. This can be used when compute instance with Management Agent has been recently created.

compartmentId String

The OCID of the compartment to which a request will be scoped.

accessLevel String

When the value is "ACCESSIBLE", insufficient permissions for a compartment will filter out resources in that compartment without rejecting the request.

availabilityStatus String

Filter to return only Management Agents in the particular availability status.

compartmentIdInSubtree Boolean

if set to true then it fetches resources for all compartments where user has access to else only on the compartment specified.

dataSourceNames List<String>

Unique name of the dataSource.

dataSourceType String

The type of the dataSource.

displayName String

Filter to return only Management Agents having the particular display name.

filters List<GetsFilter>

gatewayIds List<String>

Filter to return only results having the particular gatewayId.

hostId String

Filter to return only Management Agents having the particular agent host id.

installType String

A filter to return either agents or gateway types depending upon install type selected by user. By default both install type will be returned.

isCustomerDeployed Boolean

true, if the agent image is manually downloaded and installed. false, if the agent is deployed as a plugin in Oracle Cloud Agent.

platformTypes List<String>

Array of PlatformTypes to return only results having the particular platform types. Example: ["LINUX"]

pluginNames List<String>

Array of pluginName to return only Management Agents having the particular Plugins installed. A special pluginName of 'None' can be provided and this will return only Management Agents having no plugin installed. Example: ["PluginA"]

state String

Filter to return only Management Agents in the particular lifecycle state.

versions List<String>

Array of versions to return only Management Agents having the particular agent versions. Example: ["202020.0101","210201.0513"]

waitForHostId Integer

When host_id argument is set, the data source will wait for the given period of time (in minutes) for this host_id to become available. This can be used when compute instance with Management Agent has been recently created.

compartmentId string

The OCID of the compartment to which a request will be scoped.

accessLevel string

When the value is "ACCESSIBLE", insufficient permissions for a compartment will filter out resources in that compartment without rejecting the request.

availabilityStatus string

Filter to return only Management Agents in the particular availability status.

compartmentIdInSubtree boolean

if set to true then it fetches resources for all compartments where user has access to else only on the compartment specified.

dataSourceNames string[]

Unique name of the dataSource.

dataSourceType string

The type of the dataSource.

displayName string

Filter to return only Management Agents having the particular display name.

filters GetManagementAgentsFilter[]

gatewayIds string[]

Filter to return only results having the particular gatewayId.

hostId string

Filter to return only Management Agents having the particular agent host id.

installType string

A filter to return either agents or gateway types depending upon install type selected by user. By default both install type will be returned.

isCustomerDeployed boolean

true, if the agent image is manually downloaded and installed. false, if the agent is deployed as a plugin in Oracle Cloud Agent.

platformTypes string[]

Array of PlatformTypes to return only results having the particular platform types. Example: ["LINUX"]

pluginNames string[]

Array of pluginName to return only Management Agents having the particular Plugins installed. A special pluginName of 'None' can be provided and this will return only Management Agents having no plugin installed. Example: ["PluginA"]

state string

Filter to return only Management Agents in the particular lifecycle state.

versions string[]

Array of versions to return only Management Agents having the particular agent versions. Example: ["202020.0101","210201.0513"]

waitForHostId number

When host_id argument is set, the data source will wait for the given period of time (in minutes) for this host_id to become available. This can be used when compute instance with Management Agent has been recently created.

compartment_id str

The OCID of the compartment to which a request will be scoped.

access_level str

When the value is "ACCESSIBLE", insufficient permissions for a compartment will filter out resources in that compartment without rejecting the request.

availability_status str

Filter to return only Management Agents in the particular availability status.

compartment_id_in_subtree bool

if set to true then it fetches resources for all compartments where user has access to else only on the compartment specified.

data_source_names Sequence[str]

Unique name of the dataSource.

data_source_type str

The type of the dataSource.

display_name str

Filter to return only Management Agents having the particular display name.

filters Sequence[managementagent.GetManagementAgentsFilter]

gateway_ids Sequence[str]

Filter to return only results having the particular gatewayId.

host_id str

Filter to return only Management Agents having the particular agent host id.

install_type str

A filter to return either agents or gateway types depending upon install type selected by user. By default both install type will be returned.

is_customer_deployed bool

true, if the agent image is manually downloaded and installed. false, if the agent is deployed as a plugin in Oracle Cloud Agent.

platform_types Sequence[str]

Array of PlatformTypes to return only results having the particular platform types. Example: ["LINUX"]

plugin_names Sequence[str]

Array of pluginName to return only Management Agents having the particular Plugins installed. A special pluginName of 'None' can be provided and this will return only Management Agents having no plugin installed. Example: ["PluginA"]

state str

Filter to return only Management Agents in the particular lifecycle state.

versions Sequence[str]

Array of versions to return only Management Agents having the particular agent versions. Example: ["202020.0101","210201.0513"]

wait_for_host_id int

When host_id argument is set, the data source will wait for the given period of time (in minutes) for this host_id to become available. This can be used when compute instance with Management Agent has been recently created.

compartmentId String

The OCID of the compartment to which a request will be scoped.

accessLevel String

When the value is "ACCESSIBLE", insufficient permissions for a compartment will filter out resources in that compartment without rejecting the request.

availabilityStatus String

Filter to return only Management Agents in the particular availability status.

compartmentIdInSubtree Boolean

if set to true then it fetches resources for all compartments where user has access to else only on the compartment specified.

dataSourceNames List<String>

Unique name of the dataSource.

dataSourceType String

The type of the dataSource.

displayName String

Filter to return only Management Agents having the particular display name.

filters List<Property Map>

gatewayIds List<String>

Filter to return only results having the particular gatewayId.

hostId String

Filter to return only Management Agents having the particular agent host id.

installType String

A filter to return either agents or gateway types depending upon install type selected by user. By default both install type will be returned.

isCustomerDeployed Boolean

true, if the agent image is manually downloaded and installed. false, if the agent is deployed as a plugin in Oracle Cloud Agent.

platformTypes List<String>

Array of PlatformTypes to return only results having the particular platform types. Example: ["LINUX"]

pluginNames List<String>

Array of pluginName to return only Management Agents having the particular Plugins installed. A special pluginName of 'None' can be provided and this will return only Management Agents having no plugin installed. Example: ["PluginA"]

state String

Filter to return only Management Agents in the particular lifecycle state.

versions List<String>

Array of versions to return only Management Agents having the particular agent versions. Example: ["202020.0101","210201.0513"]

waitForHostId Number

When host_id argument is set, the data source will wait for the given period of time (in minutes) for this host_id to become available. This can be used when compute instance with Management Agent has been recently created.

CompartmentId string

Compartment Identifier

Id string

The provider-assigned unique ID for this managed resource.

ManagementAgents List<GetManagementAgentsManagementAgent>

The list of management_agents.

AccessLevel string

AvailabilityStatus string

The current availability status of managementAgent

CompartmentIdInSubtree bool

DataSourceNames List<string>

DataSourceType string

DisplayName string

Management Agent Name

Filters List<GetManagementAgentsFilter>

GatewayIds List<string>

HostId string

Host resource ocid

InstallType string

The install type, either AGENT or GATEWAY

IsCustomerDeployed bool

true, if the agent image is manually downloaded and installed. false, if the agent is deployed as a plugin in Oracle Cloud Agent.

PlatformTypes List<string>

Platform Type

PluginNames List<string>

Management Agent Plugin Name

State string

The current state of managementAgent

Versions List<string>

Management Agent Version

WaitForHostId int

CompartmentId string

Compartment Identifier

Id string

The provider-assigned unique ID for this managed resource.

ManagementAgents []GetManagementAgentsManagementAgent

The list of management_agents.

AccessLevel string

AvailabilityStatus string

The current availability status of managementAgent

CompartmentIdInSubtree bool

DataSourceNames []string

DataSourceType string

DisplayName string

Management Agent Name

Filters []GetManagementAgentsFilter

GatewayIds []string

HostId string

Host resource ocid

InstallType string

The install type, either AGENT or GATEWAY

IsCustomerDeployed bool

true, if the agent image is manually downloaded and installed. false, if the agent is deployed as a plugin in Oracle Cloud Agent.

PlatformTypes []string

Platform Type

PluginNames []string

Management Agent Plugin Name

State string

The current state of managementAgent

Versions []string

Management Agent Version

WaitForHostId int

compartmentId String

Compartment Identifier

id String

The provider-assigned unique ID for this managed resource.

managementAgents List<Gets>

The list of management_agents.

accessLevel String

availabilityStatus String

The current availability status of managementAgent

compartmentIdInSubtree Boolean

dataSourceNames List<String>

dataSourceType String

displayName String

Management Agent Name

filters List<GetsFilter>

gatewayIds List<String>

hostId String

Host resource ocid

installType String

The install type, either AGENT or GATEWAY

isCustomerDeployed Boolean

true, if the agent image is manually downloaded and installed. false, if the agent is deployed as a plugin in Oracle Cloud Agent.

platformTypes List<String>

Platform Type

pluginNames List<String>

Management Agent Plugin Name

state String

The current state of managementAgent

versions List<String>

Management Agent Version

waitForHostId Integer

compartmentId string

Compartment Identifier

id string

The provider-assigned unique ID for this managed resource.

managementAgents GetManagementAgentsManagementAgent[]

The list of management_agents.

accessLevel string

availabilityStatus string

The current availability status of managementAgent

compartmentIdInSubtree boolean

dataSourceNames string[]

dataSourceType string

displayName string

Management Agent Name

filters GetManagementAgentsFilter[]

gatewayIds string[]

hostId string

Host resource ocid

installType string

The install type, either AGENT or GATEWAY

isCustomerDeployed boolean

true, if the agent image is manually downloaded and installed. false, if the agent is deployed as a plugin in Oracle Cloud Agent.

platformTypes string[]

Platform Type

pluginNames string[]

Management Agent Plugin Name

state string

The current state of managementAgent

versions string[]

Management Agent Version

waitForHostId number

compartment_id str

Compartment Identifier

id str

The provider-assigned unique ID for this managed resource.

management_agents Sequence[managementagent.GetManagementAgentsManagementAgent]

The list of management_agents.

access_level str

availability_status str

The current availability status of managementAgent

compartment_id_in_subtree bool

data_source_names Sequence[str]

data_source_type str

display_name str

Management Agent Name

filters Sequence[managementagent.GetManagementAgentsFilter]

gateway_ids Sequence[str]

host_id str

Host resource ocid

install_type str

The install type, either AGENT or GATEWAY

is_customer_deployed bool

true, if the agent image is manually downloaded and installed. false, if the agent is deployed as a plugin in Oracle Cloud Agent.

platform_types Sequence[str]

Platform Type

plugin_names Sequence[str]

Management Agent Plugin Name

state str

The current state of managementAgent

versions Sequence[str]

Management Agent Version

wait_for_host_id int

compartmentId String

Compartment Identifier

id String

The provider-assigned unique ID for this managed resource.

managementAgents List<Property Map>

The list of management_agents.

accessLevel String

availabilityStatus String

The current availability status of managementAgent

compartmentIdInSubtree Boolean

dataSourceNames List<String>

dataSourceType String

displayName String

Management Agent Name

filters List<Property Map>

gatewayIds List<String>

hostId String

Host resource ocid

installType String

The install type, either AGENT or GATEWAY

isCustomerDeployed Boolean

true, if the agent image is manually downloaded and installed. false, if the agent is deployed as a plugin in Oracle Cloud Agent.

platformTypes List<String>

Platform Type

pluginNames List<String>

Management Agent Plugin Name

state String

The current state of managementAgent

versions List<String>

Management Agent Version

waitForHostId Number

Name string

Name of the property

Values List<string>

Values of the property

Regex bool

Name string

Name of the property

Values []string

Values of the property

Regex bool

name String

Name of the property

values List<String>

Values of the property

regex Boolean

name string

Name of the property

values string[]

Values of the property

regex boolean

name str

Name of the property

values Sequence[str]

Values of the property

regex bool

name String

Name of the property

values List<String>

Values of the property

regex Boolean

AvailabilityStatus string

Filter to return only Management Agents in the particular availability status.

CompartmentId string

The OCID of the compartment to which a request will be scoped.

DataSourceLists List<GetManagementAgentsManagementAgentDataSourceList>

DataSourceSummaryLists List<GetManagementAgentsManagementAgentDataSourceSummaryList>

list of dataSources associated with the agent

DefinedTags Dictionary<string, object>

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

DeployPluginsIds List<string>

DisplayName string

Filter to return only Management Agents having the particular display name.

FreeformTags Dictionary<string, object>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

Host string

Management Agent host machine name

HostId string

Filter to return only Management Agents having the particular agent host id.

Id string

agent identifier

InstallKeyId string

agent install key identifier

InstallPath string

Path where Management Agent is installed

InstallType string

A filter to return either agents or gateway types depending upon install type selected by user. By default both install type will be returned.

IsAgentAutoUpgradable 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 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 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.

ManagedAgentId string

ManagementAgentProperties List<GetManagementAgentsManagementAgentManagementAgentProperty>

Additional properties for this Management Agent

PlatformName string

Platform Name

PlatformType string

Array of PlatformTypes to return only results having the particular platform types. Example: ["LINUX"]

PlatformVersion string

Platform Version

PluginLists List<GetManagementAgentsManagementAgentPluginList>

list of managementAgentPlugins associated with the agent

ResourceArtifactVersion 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

State string

Filter to return only Management Agents in the particular lifecycle state.

TimeCreated string

The time the Management Agent was created. An RFC3339 formatted datetime string

TimeLastHeartbeat string

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 string

The time the Management Agent was last updated. An RFC3339 formatted datetime string

Version string

Array of versions to return only Management Agents having the particular agent versions. Example: ["202020.0101","210201.0513"]

AvailabilityStatus string

Filter to return only Management Agents in the particular availability status.

CompartmentId string

The OCID of the compartment to which a request will be scoped.

DataSourceLists []GetManagementAgentsManagementAgentDataSourceList

DataSourceSummaryLists []GetManagementAgentsManagementAgentDataSourceSummaryList

list of dataSources associated with the agent

DefinedTags map[string]interface{}

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

DeployPluginsIds []string

DisplayName string

Filter to return only Management Agents having the particular display name.

FreeformTags map[string]interface{}

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

Host string

Management Agent host machine name

HostId string

Filter to return only Management Agents having the particular agent host id.

Id string

agent identifier

InstallKeyId string

agent install key identifier

InstallPath string

Path where Management Agent is installed

InstallType string

A filter to return either agents or gateway types depending upon install type selected by user. By default both install type will be returned.

IsAgentAutoUpgradable 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 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 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.

ManagedAgentId string

ManagementAgentProperties []GetManagementAgentsManagementAgentManagementAgentProperty

Additional properties for this Management Agent

PlatformName string

Platform Name

PlatformType string

Array of PlatformTypes to return only results having the particular platform types. Example: ["LINUX"]

PlatformVersion string

Platform Version

PluginLists []GetManagementAgentsManagementAgentPluginList

list of managementAgentPlugins associated with the agent

ResourceArtifactVersion 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

State string

Filter to return only Management Agents in the particular lifecycle state.

TimeCreated string

The time the Management Agent was created. An RFC3339 formatted datetime string

TimeLastHeartbeat string

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 string

The time the Management Agent was last updated. An RFC3339 formatted datetime string

Version string

Array of versions to return only Management Agents having the particular agent versions. Example: ["202020.0101","210201.0513"]

availabilityStatus String

Filter to return only Management Agents in the particular availability status.

compartmentId String

The OCID of the compartment to which a request will be scoped.

dataSourceLists List<GetsDataSourceList>

dataSourceSummaryLists List<GetsDataSourceSummaryList>

list of dataSources associated with the agent

definedTags Map<String,Object>

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

deployPluginsIds List<String>

displayName String

Filter to return only Management Agents having the particular display name.

freeformTags Map<String,Object>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

host String

Management Agent host machine name

hostId String

Filter to return only Management Agents having the particular agent host id.

id String

agent identifier

installKeyId String

agent install key identifier

installPath String

Path where Management Agent is installed

installType String

A filter to return either agents or gateway types depending upon install type selected by user. By default both install type will be returned.

isAgentAutoUpgradable Boolean

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 Boolean

true, if the agent image is manually downloaded and installed. false, if the agent is deployed as a plugin in Oracle Cloud Agent.

lifecycleDetails 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.

managedAgentId String

managementAgentProperties List<GetsProperty>

Additional properties for this Management Agent

platformName String

Platform Name

platformType String

Array of PlatformTypes to return only results having the particular platform types. Example: ["LINUX"]

platformVersion String

Platform Version

pluginLists List<GetsPluginList>

list of managementAgentPlugins associated with the agent

resourceArtifactVersion 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

state String

Filter to return only Management Agents in the particular lifecycle state.

timeCreated String

The time the Management Agent was created. An RFC3339 formatted datetime string

timeLastHeartbeat String

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 String

The time the Management Agent was last updated. An RFC3339 formatted datetime string

version String

Array of versions to return only Management Agents having the particular agent versions. Example: ["202020.0101","210201.0513"]

availabilityStatus string

Filter to return only Management Agents in the particular availability status.

compartmentId string

The OCID of the compartment to which a request will be scoped.

dataSourceLists GetManagementAgentsManagementAgentDataSourceList[]

dataSourceSummaryLists GetManagementAgentsManagementAgentDataSourceSummaryList[]

list of dataSources associated with the agent

definedTags {[key: string]: any}

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

deployPluginsIds string[]

displayName string

Filter to return only Management Agents having the particular display name.

freeformTags {[key: string]: any}

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

host string

Management Agent host machine name

hostId string

Filter to return only Management Agents having the particular agent host id.

id string

agent identifier

installKeyId string

agent install key identifier

installPath string

Path where Management Agent is installed

installType string

A filter to return either agents or gateway types depending upon install type selected by user. By default both install type will be returned.

isAgentAutoUpgradable boolean

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 boolean

true, if the agent image is manually downloaded and installed. false, if the agent is deployed as a plugin in Oracle Cloud Agent.

lifecycleDetails 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.

managedAgentId string

managementAgentProperties GetManagementAgentsManagementAgentManagementAgentProperty[]

Additional properties for this Management Agent

platformName string

Platform Name

platformType string

Array of PlatformTypes to return only results having the particular platform types. Example: ["LINUX"]

platformVersion string

Platform Version

pluginLists GetManagementAgentsManagementAgentPluginList[]

list of managementAgentPlugins associated with the agent

resourceArtifactVersion 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

state string

Filter to return only Management Agents in the particular lifecycle state.

timeCreated string

The time the Management Agent was created. An RFC3339 formatted datetime string

timeLastHeartbeat string

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 string

The time the Management Agent was last updated. An RFC3339 formatted datetime string

version string

Array of versions to return only Management Agents having the particular agent versions. Example: ["202020.0101","210201.0513"]

availability_status str

Filter to return only Management Agents in the particular availability status.

compartment_id str

The OCID of the compartment to which a request will be scoped.

data_source_lists Sequence[managementagent.GetManagementAgentsManagementAgentDataSourceList]

data_source_summary_lists Sequence[managementagent.GetManagementAgentsManagementAgentDataSourceSummaryList]

list of dataSources associated with the agent

defined_tags Mapping[str, Any]

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

deploy_plugins_ids Sequence[str]

display_name str

Filter to return only Management Agents having the particular display name.

freeform_tags Mapping[str, Any]

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

host str

Management Agent host machine name

host_id str

Filter to return only Management Agents having the particular agent host id.

id str

agent identifier

install_key_id str

agent install key identifier

install_path str

Path where Management Agent is installed

install_type str

A filter to return either agents or gateway types depending upon install type selected by user. By default both install type will be returned.

is_agent_auto_upgradable 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.

is_customer_deployed bool

true, if the agent image is manually downloaded and installed. false, if the agent is deployed as a plugin in Oracle Cloud Agent.

lifecycle_details str

A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

managed_agent_id str

management_agent_properties Sequence[managementagent.GetManagementAgentsManagementAgentManagementAgentProperty]

Additional properties for this Management Agent

platform_name str

Platform Name

platform_type str

Array of PlatformTypes to return only results having the particular platform types. Example: ["LINUX"]

platform_version str

Platform Version

plugin_lists Sequence[managementagent.GetManagementAgentsManagementAgentPluginList]

list of managementAgentPlugins associated with the agent

resource_artifact_version str

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

state str

Filter to return only Management Agents in the particular lifecycle state.

time_created str

The time the Management Agent was created. An RFC3339 formatted datetime string

time_last_heartbeat str

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

time_updated str

The time the Management Agent was last updated. An RFC3339 formatted datetime string

version str

Array of versions to return only Management Agents having the particular agent versions. Example: ["202020.0101","210201.0513"]

availabilityStatus String

Filter to return only Management Agents in the particular availability status.

compartmentId String

The OCID of the compartment to which a request will be scoped.

dataSourceLists List<Property Map>

dataSourceSummaryLists List<Property Map>

list of dataSources associated with the agent

definedTags Map<Any>

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

deployPluginsIds List<String>

displayName String

Filter to return only Management Agents having the particular display name.

freeformTags Map<Any>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

host String

Management Agent host machine name

hostId String

Filter to return only Management Agents having the particular agent host id.

id String

agent identifier

installKeyId String

agent install key identifier

installPath String

Path where Management Agent is installed

installType String

A filter to return either agents or gateway types depending upon install type selected by user. By default both install type will be returned.

isAgentAutoUpgradable Boolean

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 Boolean

true, if the agent image is manually downloaded and installed. false, if the agent is deployed as a plugin in Oracle Cloud Agent.

lifecycleDetails 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.

managedAgentId String

managementAgentProperties List<Property Map>

Additional properties for this Management Agent

platformName String

Platform Name

platformType String

Array of PlatformTypes to return only results having the particular platform types. Example: ["LINUX"]

platformVersion String

Platform Version

pluginLists List<Property Map>

list of managementAgentPlugins associated with the agent

resourceArtifactVersion 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

state String

Filter to return only Management Agents in the particular lifecycle state.

timeCreated String

The time the Management Agent was created. An RFC3339 formatted datetime string

timeLastHeartbeat String

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 String

The time the Management Agent was last updated. An RFC3339 formatted datetime string

version String

Array of versions to return only Management Agents having the particular agent versions. Example: ["202020.0101","210201.0513"]

AllowMetrics string

CompartmentId string

The OCID of the compartment to which a request will be scoped.

ConnectionTimeout int

IsDaemonSet bool

If the Kubernetes cluster type is Daemon set then this will be set to true.

Key string

Identifier for DataSource. This represents the type and name for the data source associated with the Management Agent.

MetricDimensions List<GetManagementAgentsManagementAgentDataSourceListMetricDimension>

Name string

Name of the property

Namespace string

ProxyUrl string

ReadDataLimit int

ReadTimeout int

ResourceGroup string

ScheduleMins int

State string

Filter to return only Management Agents in the particular lifecycle state.

TimeCreated string

The time the Management Agent was created. An RFC3339 formatted datetime string

TimeUpdated string

The time the Management Agent was last updated. An RFC3339 formatted datetime string

Type string

The type of the DataSource.

Url string

AllowMetrics string

CompartmentId string

The OCID of the compartment to which a request will be scoped.

ConnectionTimeout int

IsDaemonSet bool

If the Kubernetes cluster type is Daemon set then this will be set to true.

Key string

Identifier for DataSource. This represents the type and name for the data source associated with the Management Agent.

MetricDimensions []GetManagementAgentsManagementAgentDataSourceListMetricDimension

Name string

Name of the property

Namespace string

ProxyUrl string

ReadDataLimit int

ReadTimeout int

ResourceGroup string

ScheduleMins int

State string

Filter to return only Management Agents in the particular lifecycle state.

TimeCreated string

The time the Management Agent was created. An RFC3339 formatted datetime string

TimeUpdated string

The time the Management Agent was last updated. An RFC3339 formatted datetime string

Type string

The type of the DataSource.

Url string

allowMetrics String

compartmentId String

The OCID of the compartment to which a request will be scoped.

connectionTimeout Integer

isDaemonSet Boolean

If the Kubernetes cluster type is Daemon set then this will be set to true.

key String

Identifier for DataSource. This represents the type and name for the data source associated with the Management Agent.

metricDimensions List<GetsDataSourceListMetricDimension>

name String

Name of the property

namespace String

proxyUrl String

readDataLimit Integer

readTimeout Integer

resourceGroup String

scheduleMins Integer

state String

Filter to return only Management Agents in the particular lifecycle state.

timeCreated String

The time the Management Agent was created. An RFC3339 formatted datetime string

timeUpdated String

The time the Management Agent was last updated. An RFC3339 formatted datetime string

type String

The type of the DataSource.

url String

allowMetrics string

compartmentId string

The OCID of the compartment to which a request will be scoped.

connectionTimeout number

isDaemonSet boolean

If the Kubernetes cluster type is Daemon set then this will be set to true.

key string

Identifier for DataSource. This represents the type and name for the data source associated with the Management Agent.

metricDimensions GetManagementAgentsManagementAgentDataSourceListMetricDimension[]

name string

Name of the property

namespace string

proxyUrl string

readDataLimit number

readTimeout number

resourceGroup string

scheduleMins number

state string

Filter to return only Management Agents in the particular lifecycle state.

timeCreated string

The time the Management Agent was created. An RFC3339 formatted datetime string

timeUpdated string

The time the Management Agent was last updated. An RFC3339 formatted datetime string

type string

The type of the DataSource.

url string

allow_metrics str

compartment_id str

The OCID of the compartment to which a request will be scoped.

connection_timeout int

is_daemon_set bool

If the Kubernetes cluster type is Daemon set then this will be set to true.

key str

Identifier for DataSource. This represents the type and name for the data source associated with the Management Agent.

metric_dimensions Sequence[managementagent.GetManagementAgentsManagementAgentDataSourceListMetricDimension]

name str

Name of the property

namespace str

proxy_url str

read_data_limit int

read_timeout int

resource_group str

schedule_mins int

state str

Filter to return only Management Agents in the particular lifecycle state.

time_created str

The time the Management Agent was created. An RFC3339 formatted datetime string

time_updated str

The time the Management Agent was last updated. An RFC3339 formatted datetime string

type str

The type of the DataSource.

url str

allowMetrics String

compartmentId String

The OCID of the compartment to which a request will be scoped.

connectionTimeout Number

isDaemonSet Boolean

If the Kubernetes cluster type is Daemon set then this will be set to true.

key String

Identifier for DataSource. This represents the type and name for the data source associated with the Management Agent.

metricDimensions List<Property Map>

name String

Name of the property

namespace String

proxyUrl String

readDataLimit Number

readTimeout Number

resourceGroup String

scheduleMins Number

state String

Filter to return only Management Agents in the particular lifecycle state.

timeCreated String

The time the Management Agent was created. An RFC3339 formatted datetime string

timeUpdated String

The time the Management Agent was last updated. An RFC3339 formatted datetime string

type String

The type of the DataSource.

url String

Name string

Name of the property

Value string

Name string

Name of the property

Value string

name String

Name of the property

value String

name string

Name of the property

value string

name str

Name of the property

value str

name String

Name of the property

value String

IsDaemonSet bool

If the Kubernetes cluster type is Daemon set then this will be set to true.

Key string

Identifier for DataSource. This represents the type and name for the data source associated with the Management Agent.

Name string

Name of the property

Type string

The type of the DataSource.

IsDaemonSet bool

If the Kubernetes cluster type is Daemon set then this will be set to true.

Key string

Identifier for DataSource. This represents the type and name for the data source associated with the Management Agent.

Name string

Name of the property

Type string

The type of the DataSource.

isDaemonSet Boolean

If the Kubernetes cluster type is Daemon set then this will be set to true.

key String

Identifier for DataSource. This represents the type and name for the data source associated with the Management Agent.

name String

Name of the property

type String

The type of the DataSource.

isDaemonSet boolean

If the Kubernetes cluster type is Daemon set then this will be set to true.

key string

Identifier for DataSource. This represents the type and name for the data source associated with the Management Agent.

name string

Name of the property

type string

The type of the DataSource.

is_daemon_set bool

If the Kubernetes cluster type is Daemon set then this will be set to true.

key str

Identifier for DataSource. This represents the type and name for the data source associated with the Management Agent.

name str

Name of the property

type str

The type of the DataSource.

isDaemonSet Boolean

If the Kubernetes cluster type is Daemon set then this will be set to true.

key String

Identifier for DataSource. This represents the type and name for the data source associated with the Management Agent.

name String

Name of the property

type String

The type of the DataSource.

Name string

Name of the property

Units string

Unit for the property

Values List<string>

Values of the property

Name string

Name of the property

Units string

Unit for the property

Values []string

Values of the property

name String

Name of the property

units String

Unit for the property

values List<String>

Values of the property

name string

Name of the property

units string

Unit for the property

values string[]

Values of the property

name str

Name of the property

units str

Unit for the property

values Sequence[str]

Values of the property

name String

Name of the property

units String

Unit for the property

values List<String>

Values of the property

IsEnabled bool

flag indicating whether the plugin is in enabled mode or disabled mode.

PluginDisplayName string

Management Agent Plugin Identifier, can be renamed

PluginId string

Plugin Id

PluginName string

Array of pluginName to return only Management Agents having the particular Plugins installed. A special pluginName of 'None' can be provided and this will return only Management Agents having no plugin installed. Example: ["PluginA"]

PluginStatus string

Plugin Status

PluginStatusMessage string

Status message of the Plugin

PluginVersion string

Plugin Version

IsEnabled bool

flag indicating whether the plugin is in enabled mode or disabled mode.

PluginDisplayName string

Management Agent Plugin Identifier, can be renamed

PluginId string

Plugin Id

PluginName string

Array of pluginName to return only Management Agents having the particular Plugins installed. A special pluginName of 'None' can be provided and this will return only Management Agents having no plugin installed. Example: ["PluginA"]

PluginStatus string

Plugin Status

PluginStatusMessage string

Status message of the Plugin

PluginVersion string

Plugin Version

isEnabled Boolean

flag indicating whether the plugin is in enabled mode or disabled mode.

pluginDisplayName String

Management Agent Plugin Identifier, can be renamed

pluginId String

Plugin Id

pluginName String

Array of pluginName to return only Management Agents having the particular Plugins installed. A special pluginName of 'None' can be provided and this will return only Management Agents having no plugin installed. Example: ["PluginA"]

pluginStatus String

Plugin Status

pluginStatusMessage String

Status message of the Plugin

pluginVersion String

Plugin Version

isEnabled boolean

flag indicating whether the plugin is in enabled mode or disabled mode.

pluginDisplayName string

Management Agent Plugin Identifier, can be renamed

pluginId string

Plugin Id

pluginName string

Array of pluginName to return only Management Agents having the particular Plugins installed. A special pluginName of 'None' can be provided and this will return only Management Agents having no plugin installed. Example: ["PluginA"]

pluginStatus string

Plugin Status

pluginStatusMessage string

Status message of the Plugin

pluginVersion string

Plugin Version

is_enabled bool

flag indicating whether the plugin is in enabled mode or disabled mode.

plugin_display_name str

Management Agent Plugin Identifier, can be renamed

plugin_id str

Plugin Id

plugin_name str

Array of pluginName to return only Management Agents having the particular Plugins installed. A special pluginName of 'None' can be provided and this will return only Management Agents having no plugin installed. Example: ["PluginA"]

plugin_status str

Plugin Status

plugin_status_message str

Status message of the Plugin

plugin_version str

Plugin Version

isEnabled Boolean

flag indicating whether the plugin is in enabled mode or disabled mode.

pluginDisplayName String

Management Agent Plugin Identifier, can be renamed

pluginId String

Plugin Id

pluginName String

Array of pluginName to return only Management Agents having the particular Plugins installed. A special pluginName of 'None' can be provided and this will return only Management Agents having no plugin installed. Example: ["PluginA"]

pluginStatus String

Plugin Status

pluginStatusMessage String

Status message of the Plugin

pluginVersion String

Plugin Version