1. Packages
  2. Fortimanager Provider
  3. API Docs
  4. ObjectTelemetrycontrollerAgentprofile
fortimanager 1.15.0 published on Thursday, Nov 13, 2025 by fortinetdev
fortimanager logo
fortimanager 1.15.0 published on Thursday, Nov 13, 2025 by fortinetdev

    Configure FortiTelemetry agent profiles.

    Create ObjectTelemetrycontrollerAgentprofile Resource

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

    Constructor syntax

    new ObjectTelemetrycontrollerAgentprofile(name: string, args?: ObjectTelemetrycontrollerAgentprofileArgs, opts?: CustomResourceOptions);
    @overload
    def ObjectTelemetrycontrollerAgentprofile(resource_name: str,
                                              args: Optional[ObjectTelemetrycontrollerAgentprofileArgs] = None,
                                              opts: Optional[ResourceOptions] = None)
    
    @overload
    def ObjectTelemetrycontrollerAgentprofile(resource_name: str,
                                              opts: Optional[ResourceOptions] = None,
                                              adom: Optional[str] = None,
                                              comment: Optional[str] = None,
                                              model: Optional[str] = None,
                                              name: Optional[str] = None,
                                              object_telemetrycontroller_agentprofile_id: Optional[str] = None,
                                              scopetype: Optional[str] = None)
    func NewObjectTelemetrycontrollerAgentprofile(ctx *Context, name string, args *ObjectTelemetrycontrollerAgentprofileArgs, opts ...ResourceOption) (*ObjectTelemetrycontrollerAgentprofile, error)
    public ObjectTelemetrycontrollerAgentprofile(string name, ObjectTelemetrycontrollerAgentprofileArgs? args = null, CustomResourceOptions? opts = null)
    public ObjectTelemetrycontrollerAgentprofile(String name, ObjectTelemetrycontrollerAgentprofileArgs args)
    public ObjectTelemetrycontrollerAgentprofile(String name, ObjectTelemetrycontrollerAgentprofileArgs args, CustomResourceOptions options)
    
    type: fortimanager:ObjectTelemetrycontrollerAgentprofile
    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 ObjectTelemetrycontrollerAgentprofileArgs
    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 ObjectTelemetrycontrollerAgentprofileArgs
    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 ObjectTelemetrycontrollerAgentprofileArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ObjectTelemetrycontrollerAgentprofileArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ObjectTelemetrycontrollerAgentprofileArgs
    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 objectTelemetrycontrollerAgentprofileResource = new Fortimanager.ObjectTelemetrycontrollerAgentprofile("objectTelemetrycontrollerAgentprofileResource", new()
    {
        Adom = "string",
        Comment = "string",
        Model = "string",
        Name = "string",
        ObjectTelemetrycontrollerAgentprofileId = "string",
        Scopetype = "string",
    });
    
    example, err := fortimanager.NewObjectTelemetrycontrollerAgentprofile(ctx, "objectTelemetrycontrollerAgentprofileResource", &fortimanager.ObjectTelemetrycontrollerAgentprofileArgs{
    	Adom:                                    pulumi.String("string"),
    	Comment:                                 pulumi.String("string"),
    	Model:                                   pulumi.String("string"),
    	Name:                                    pulumi.String("string"),
    	ObjectTelemetrycontrollerAgentprofileId: pulumi.String("string"),
    	Scopetype:                               pulumi.String("string"),
    })
    
    var objectTelemetrycontrollerAgentprofileResource = new ObjectTelemetrycontrollerAgentprofile("objectTelemetrycontrollerAgentprofileResource", ObjectTelemetrycontrollerAgentprofileArgs.builder()
        .adom("string")
        .comment("string")
        .model("string")
        .name("string")
        .objectTelemetrycontrollerAgentprofileId("string")
        .scopetype("string")
        .build());
    
    object_telemetrycontroller_agentprofile_resource = fortimanager.ObjectTelemetrycontrollerAgentprofile("objectTelemetrycontrollerAgentprofileResource",
        adom="string",
        comment="string",
        model="string",
        name="string",
        object_telemetrycontroller_agentprofile_id="string",
        scopetype="string")
    
    const objectTelemetrycontrollerAgentprofileResource = new fortimanager.ObjectTelemetrycontrollerAgentprofile("objectTelemetrycontrollerAgentprofileResource", {
        adom: "string",
        comment: "string",
        model: "string",
        name: "string",
        objectTelemetrycontrollerAgentprofileId: "string",
        scopetype: "string",
    });
    
    type: fortimanager:ObjectTelemetrycontrollerAgentprofile
    properties:
        adom: string
        comment: string
        model: string
        name: string
        objectTelemetrycontrollerAgentprofileId: string
        scopetype: string
    

    ObjectTelemetrycontrollerAgentprofile 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 ObjectTelemetrycontrollerAgentprofile 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.
    Comment string
    Comment.
    Model string
    Model. Valid values: FTL100G, WINDOWS.
    Name string
    Name of the agent profile.
    ObjectTelemetrycontrollerAgentprofileId string
    an identifier for the resource with format {{name}}.
    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.
    Comment string
    Comment.
    Model string
    Model. Valid values: FTL100G, WINDOWS.
    Name string
    Name of the agent profile.
    ObjectTelemetrycontrollerAgentprofileId string
    an identifier for the resource with format {{name}}.
    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.
    comment String
    Comment.
    model String
    Model. Valid values: FTL100G, WINDOWS.
    name String
    Name of the agent profile.
    objectTelemetrycontrollerAgentprofileId String
    an identifier for the resource with format {{name}}.
    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.
    comment string
    Comment.
    model string
    Model. Valid values: FTL100G, WINDOWS.
    name string
    Name of the agent profile.
    objectTelemetrycontrollerAgentprofileId string
    an identifier for the resource with format {{name}}.
    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.
    comment str
    Comment.
    model str
    Model. Valid values: FTL100G, WINDOWS.
    name str
    Name of the agent profile.
    object_telemetrycontroller_agentprofile_id str
    an identifier for the resource with format {{name}}.
    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.
    comment String
    Comment.
    model String
    Model. Valid values: FTL100G, WINDOWS.
    name String
    Name of the agent profile.
    objectTelemetrycontrollerAgentprofileId String
    an identifier for the resource with format {{name}}.
    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 ObjectTelemetrycontrollerAgentprofile 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 ObjectTelemetrycontrollerAgentprofile Resource

    Get an existing ObjectTelemetrycontrollerAgentprofile 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?: ObjectTelemetrycontrollerAgentprofileState, opts?: CustomResourceOptions): ObjectTelemetrycontrollerAgentprofile
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            adom: Optional[str] = None,
            comment: Optional[str] = None,
            model: Optional[str] = None,
            name: Optional[str] = None,
            object_telemetrycontroller_agentprofile_id: Optional[str] = None,
            scopetype: Optional[str] = None) -> ObjectTelemetrycontrollerAgentprofile
    func GetObjectTelemetrycontrollerAgentprofile(ctx *Context, name string, id IDInput, state *ObjectTelemetrycontrollerAgentprofileState, opts ...ResourceOption) (*ObjectTelemetrycontrollerAgentprofile, error)
    public static ObjectTelemetrycontrollerAgentprofile Get(string name, Input<string> id, ObjectTelemetrycontrollerAgentprofileState? state, CustomResourceOptions? opts = null)
    public static ObjectTelemetrycontrollerAgentprofile get(String name, Output<String> id, ObjectTelemetrycontrollerAgentprofileState state, CustomResourceOptions options)
    resources:  _:    type: fortimanager:ObjectTelemetrycontrollerAgentprofile    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.
    Comment string
    Comment.
    Model string
    Model. Valid values: FTL100G, WINDOWS.
    Name string
    Name of the agent profile.
    ObjectTelemetrycontrollerAgentprofileId string
    an identifier for the resource with format {{name}}.
    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.
    Comment string
    Comment.
    Model string
    Model. Valid values: FTL100G, WINDOWS.
    Name string
    Name of the agent profile.
    ObjectTelemetrycontrollerAgentprofileId string
    an identifier for the resource with format {{name}}.
    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.
    comment String
    Comment.
    model String
    Model. Valid values: FTL100G, WINDOWS.
    name String
    Name of the agent profile.
    objectTelemetrycontrollerAgentprofileId String
    an identifier for the resource with format {{name}}.
    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.
    comment string
    Comment.
    model string
    Model. Valid values: FTL100G, WINDOWS.
    name string
    Name of the agent profile.
    objectTelemetrycontrollerAgentprofileId string
    an identifier for the resource with format {{name}}.
    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.
    comment str
    Comment.
    model str
    Model. Valid values: FTL100G, WINDOWS.
    name str
    Name of the agent profile.
    object_telemetrycontroller_agentprofile_id str
    an identifier for the resource with format {{name}}.
    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.
    comment String
    Comment.
    model String
    Model. Valid values: FTL100G, WINDOWS.
    name String
    Name of the agent profile.
    objectTelemetrycontrollerAgentprofileId String
    an identifier for the resource with format {{name}}.
    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 AgentProfile can be imported using any of these accepted formats:

    $ export “FORTIMANAGER_IMPORT_TABLE”=“true”

    $ pulumi import fortimanager:index/objectTelemetrycontrollerAgentprofile:ObjectTelemetrycontrollerAgentprofile labelname {{name}}
    

    $ 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
      Meet Neo: Your AI Platform Teammate