1. Packages
  2. Fortimanager Provider
  3. API Docs
  4. ObjectTelemetrycontrollerAgent
fortimanager 1.15.0 published on Thursday, Nov 13, 2025 by fortinetdev
Schema (JSON)
fortinetdev/terraform-provider-fortimanager

fortimanager.ObjectTelemetrycontrollerAgent

fortimanager logo
fortimanager 1.15.0 published on Thursday, Nov 13, 2025 by fortinetdev
Schema (JSON)
fortinetdev/terraform-provider-fortimanager

    Configure FortiTelemetry agents managed by a FortiGate unit.

    Create ObjectTelemetrycontrollerAgent Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ObjectTelemetrycontrollerAgent(name: string, args?: ObjectTelemetrycontrollerAgentArgs, opts?: CustomResourceOptions);
    @overload
def ObjectTelemetrycontrollerAgent(resource_name: str,
                                   args: Optional[ObjectTelemetrycontrollerAgentArgs] = None,
                                   opts: Optional[ResourceOptions] = None)

@overload
def ObjectTelemetrycontrollerAgent(resource_name: str,
                                   opts: Optional[ResourceOptions] = None,
                                   adom: Optional[str] = None,
                                   agent_id: Optional[str] = None,
                                   agent_profiles: Optional[Sequence[str]] = None,
                                   alias: Optional[str] = None,
                                   authz: Optional[str] = None,
                                   comment: Optional[str] = None,
                                   object_telemetrycontroller_agent_id: Optional[str] = None,
                                   scopetype: Optional[str] = None)
    func NewObjectTelemetrycontrollerAgent(ctx *Context, name string, args *ObjectTelemetrycontrollerAgentArgs, opts ...ResourceOption) (*ObjectTelemetrycontrollerAgent, error)
    public ObjectTelemetrycontrollerAgent(string name, ObjectTelemetrycontrollerAgentArgs? args = null, CustomResourceOptions? opts = null)
    public ObjectTelemetrycontrollerAgent(String name, ObjectTelemetrycontrollerAgentArgs args)
public ObjectTelemetrycontrollerAgent(String name, ObjectTelemetrycontrollerAgentArgs args, CustomResourceOptions options)

    type: fortimanager:ObjectTelemetrycontrollerAgent
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ObjectTelemetrycontrollerAgentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ObjectTelemetrycontrollerAgentArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ObjectTelemetrycontrollerAgentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ObjectTelemetrycontrollerAgentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ObjectTelemetrycontrollerAgentArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var objectTelemetrycontrollerAgentResource = new Fortimanager.ObjectTelemetrycontrollerAgent("objectTelemetrycontrollerAgentResource", new()
{
    Adom = "string",
    AgentId = "string",
    AgentProfiles = new[]
    {
        "string",
    },
    Alias = "string",
    Authz = "string",
    Comment = "string",
    ObjectTelemetrycontrollerAgentId = "string",
    Scopetype = "string",
});

    example, err := fortimanager.NewObjectTelemetrycontrollerAgent(ctx, "objectTelemetrycontrollerAgentResource", &fortimanager.ObjectTelemetrycontrollerAgentArgs{
	Adom:    pulumi.String("string"),
	AgentId: pulumi.String("string"),
	AgentProfiles: pulumi.StringArray{
		pulumi.String("string"),
	},
	Alias:                            pulumi.String("string"),
	Authz:                            pulumi.String("string"),
	Comment:                          pulumi.String("string"),
	ObjectTelemetrycontrollerAgentId: pulumi.String("string"),
	Scopetype:                        pulumi.String("string"),
})

    var objectTelemetrycontrollerAgentResource = new ObjectTelemetrycontrollerAgent("objectTelemetrycontrollerAgentResource", ObjectTelemetrycontrollerAgentArgs.builder()
    .adom("string")
    .agentId("string")
    .agentProfiles("string")
    .alias("string")
    .authz("string")
    .comment("string")
    .objectTelemetrycontrollerAgentId("string")
    .scopetype("string")
    .build());

    object_telemetrycontroller_agent_resource = fortimanager.ObjectTelemetrycontrollerAgent("objectTelemetrycontrollerAgentResource",
    adom="string",
    agent_id="string",
    agent_profiles=["string"],
    alias="string",
    authz="string",
    comment="string",
    object_telemetrycontroller_agent_id="string",
    scopetype="string")

    const objectTelemetrycontrollerAgentResource = new fortimanager.ObjectTelemetrycontrollerAgent("objectTelemetrycontrollerAgentResource", {
    adom: "string",
    agentId: "string",
    agentProfiles: ["string"],
    alias: "string",
    authz: "string",
    comment: "string",
    objectTelemetrycontrollerAgentId: "string",
    scopetype: "string",
});

    type: fortimanager:ObjectTelemetrycontrollerAgent
properties:
    adom: string
    agentId: string
    agentProfiles:
        - string
    alias: string
    authz: string
    comment: string
    objectTelemetrycontrollerAgentId: string
    scopetype: string

    ObjectTelemetrycontrollerAgent Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ObjectTelemetrycontrollerAgent resource accepts the following input properties:

    Adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    AgentId string
    Agent ID.
    AgentProfiles List<string>
    Name of an existing agent profile.
    Alias string
    Alias used in display for ease of distinguishing agents.
    Authz string
    Authorization status of this agent. Valid values: authorized, rejected, unauthorized.
    Comment string
    Comment.
    ObjectTelemetrycontrollerAgentId string
    an identifier for the resource with format {{agent_id}}.
    Scopetype string
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    Adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    AgentId string
    Agent ID.
    AgentProfiles []string
    Name of an existing agent profile.
    Alias string
    Alias used in display for ease of distinguishing agents.
    Authz string
    Authorization status of this agent. Valid values: authorized, rejected, unauthorized.
    Comment string
    Comment.
    ObjectTelemetrycontrollerAgentId string
    an identifier for the resource with format {{agent_id}}.
    Scopetype string
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    adom String
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    agentId String
    Agent ID.
    agentProfiles List<String>
    Name of an existing agent profile.
    alias String
    Alias used in display for ease of distinguishing agents.
    authz String
    Authorization status of this agent. Valid values: authorized, rejected, unauthorized.
    comment String
    Comment.
    objectTelemetrycontrollerAgentId String
    an identifier for the resource with format {{agent_id}}.
    scopetype String
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    agentId string
    Agent ID.
    agentProfiles string[]
    Name of an existing agent profile.
    alias string
    Alias used in display for ease of distinguishing agents.
    authz string
    Authorization status of this agent. Valid values: authorized, rejected, unauthorized.
    comment string
    Comment.
    objectTelemetrycontrollerAgentId string
    an identifier for the resource with format {{agent_id}}.
    scopetype string
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    adom str
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    agent_id str
    Agent ID.
    agent_profiles Sequence[str]
    Name of an existing agent profile.
    alias str
    Alias used in display for ease of distinguishing agents.
    authz str
    Authorization status of this agent. Valid values: authorized, rejected, unauthorized.
    comment str
    Comment.
    object_telemetrycontroller_agent_id str
    an identifier for the resource with format {{agent_id}}.
    scopetype str
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    adom String
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    agentId String
    Agent ID.
    agentProfiles List<String>
    Name of an existing agent profile.
    alias String
    Alias used in display for ease of distinguishing agents.
    authz String
    Authorization status of this agent. Valid values: authorized, rejected, unauthorized.
    comment String
    Comment.
    objectTelemetrycontrollerAgentId String
    an identifier for the resource with format {{agent_id}}.
    scopetype String
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ObjectTelemetrycontrollerAgent resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing ObjectTelemetrycontrollerAgent Resource

    Get an existing ObjectTelemetrycontrollerAgent resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ObjectTelemetrycontrollerAgentState, opts?: CustomResourceOptions): ObjectTelemetrycontrollerAgent
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        adom: Optional[str] = None,
        agent_id: Optional[str] = None,
        agent_profiles: Optional[Sequence[str]] = None,
        alias: Optional[str] = None,
        authz: Optional[str] = None,
        comment: Optional[str] = None,
        object_telemetrycontroller_agent_id: Optional[str] = None,
        scopetype: Optional[str] = None) -> ObjectTelemetrycontrollerAgent
    func GetObjectTelemetrycontrollerAgent(ctx *Context, name string, id IDInput, state *ObjectTelemetrycontrollerAgentState, opts ...ResourceOption) (*ObjectTelemetrycontrollerAgent, error)
    public static ObjectTelemetrycontrollerAgent Get(string name, Input<string> id, ObjectTelemetrycontrollerAgentState? state, CustomResourceOptions? opts = null)
    public static ObjectTelemetrycontrollerAgent get(String name, Output<String> id, ObjectTelemetrycontrollerAgentState state, CustomResourceOptions options)
    resources:  _:    type: fortimanager:ObjectTelemetrycontrollerAgent    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    AgentId string
    Agent ID.
    AgentProfiles List<string>
    Name of an existing agent profile.
    Alias string
    Alias used in display for ease of distinguishing agents.
    Authz string
    Authorization status of this agent. Valid values: authorized, rejected, unauthorized.
    Comment string
    Comment.
    ObjectTelemetrycontrollerAgentId string
    an identifier for the resource with format {{agent_id}}.
    Scopetype string
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    Adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    AgentId string
    Agent ID.
    AgentProfiles []string
    Name of an existing agent profile.
    Alias string
    Alias used in display for ease of distinguishing agents.
    Authz string
    Authorization status of this agent. Valid values: authorized, rejected, unauthorized.
    Comment string
    Comment.
    ObjectTelemetrycontrollerAgentId string
    an identifier for the resource with format {{agent_id}}.
    Scopetype string
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    adom String
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    agentId String
    Agent ID.
    agentProfiles List<String>
    Name of an existing agent profile.
    alias String
    Alias used in display for ease of distinguishing agents.
    authz String
    Authorization status of this agent. Valid values: authorized, rejected, unauthorized.
    comment String
    Comment.
    objectTelemetrycontrollerAgentId String
    an identifier for the resource with format {{agent_id}}.
    scopetype String
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    agentId string
    Agent ID.
    agentProfiles string[]
    Name of an existing agent profile.
    alias string
    Alias used in display for ease of distinguishing agents.
    authz string
    Authorization status of this agent. Valid values: authorized, rejected, unauthorized.
    comment string
    Comment.
    objectTelemetrycontrollerAgentId string
    an identifier for the resource with format {{agent_id}}.
    scopetype string
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    adom str
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    agent_id str
    Agent ID.
    agent_profiles Sequence[str]
    Name of an existing agent profile.
    alias str
    Alias used in display for ease of distinguishing agents.
    authz str
    Authorization status of this agent. Valid values: authorized, rejected, unauthorized.
    comment str
    Comment.
    object_telemetrycontroller_agent_id str
    an identifier for the resource with format {{agent_id}}.
    scopetype str
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    adom String
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    agentId String
    Agent ID.
    agentProfiles List<String>
    Name of an existing agent profile.
    alias String
    Alias used in display for ease of distinguishing agents.
    authz String
    Authorization status of this agent. Valid values: authorized, rejected, unauthorized.
    comment String
    Comment.
    objectTelemetrycontrollerAgentId String
    an identifier for the resource with format {{agent_id}}.
    scopetype String
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.

    Import

    ObjectTelemetryController Agent can be imported using any of these accepted formats:

    $ export “FORTIMANAGER_IMPORT_TABLE”=“true”

    $ pulumi import fortimanager:index/objectTelemetrycontrollerAgent:ObjectTelemetrycontrollerAgent labelname {{agent_id}}

    $ unset “FORTIMANAGER_IMPORT_TABLE”

    -> Hint: The scopetype and adom for import will directly inherit the scopetype and adom configuration of the provider.

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    fortimanager fortinetdev/terraform-provider-fortimanager
    License
    Notes
    This Pulumi package is based on the fortimanager Terraform Provider.
    fortimanager logo
    fortimanager 1.15.0 published on Thursday, Nov 13, 2025 by fortinetdev
    Schema (JSON)
    fortinetdev/terraform-provider-fortimanager
      Meet Neo: Your AI Platform Teammate