1. Packages
  2. Fortimanager Provider
  3. API Docs
  4. ObjectSystemExternalresource
fortimanager 1.14.0 published on Tuesday, Apr 15, 2025 by fortinetdev

fortimanager.ObjectSystemExternalresource

Explore with Pulumi AI

fortimanager logo
fortimanager 1.14.0 published on Tuesday, Apr 15, 2025 by fortinetdev

    Configure external resource.

    The following variables have sub resource. Avoid using them together, otherwise conflicts and overwrites may occur.

    • dynamic_mapping: fortimanager_object_system_externalresource_dynamic_mapping

    Example Usage

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    resources:
      trname:
        type: fortimanager:ObjectSystemExternalresource
        properties:
          category: 192
          comment: This is a Terraform example
    

    Create ObjectSystemExternalresource Resource

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

    Constructor syntax

    new ObjectSystemExternalresource(name: string, args?: ObjectSystemExternalresourceArgs, opts?: CustomResourceOptions);
    @overload
    def ObjectSystemExternalresource(resource_name: str,
                                     args: Optional[ObjectSystemExternalresourceArgs] = None,
                                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def ObjectSystemExternalresource(resource_name: str,
                                     opts: Optional[ResourceOptions] = None,
                                     address_comment_field: Optional[str] = None,
                                     address_data_field: Optional[str] = None,
                                     address_name_field: Optional[str] = None,
                                     adom: Optional[str] = None,
                                     category: Optional[float] = None,
                                     client_cert_auth: Optional[str] = None,
                                     client_certs: Optional[Sequence[str]] = None,
                                     comments: Optional[str] = None,
                                     dynamic_mappings: Optional[Sequence[ObjectSystemExternalresourceDynamicMappingArgs]] = None,
                                     dynamic_sort_subtable: Optional[str] = None,
                                     interface: Optional[str] = None,
                                     interface_select_method: Optional[str] = None,
                                     name: Optional[str] = None,
                                     namespace: Optional[str] = None,
                                     object_array_path: Optional[str] = None,
                                     object_system_externalresource_id: Optional[str] = None,
                                     passwords: Optional[Sequence[str]] = None,
                                     refresh_rate: Optional[float] = None,
                                     resource: Optional[str] = None,
                                     scopetype: Optional[str] = None,
                                     server_identity_check: Optional[str] = None,
                                     source_ip: Optional[str] = None,
                                     status: Optional[str] = None,
                                     type: Optional[str] = None,
                                     update_method: Optional[str] = None,
                                     user_agent: Optional[str] = None,
                                     username: Optional[str] = None,
                                     uuid: Optional[str] = None,
                                     vrf_select: Optional[float] = None)
    func NewObjectSystemExternalresource(ctx *Context, name string, args *ObjectSystemExternalresourceArgs, opts ...ResourceOption) (*ObjectSystemExternalresource, error)
    public ObjectSystemExternalresource(string name, ObjectSystemExternalresourceArgs? args = null, CustomResourceOptions? opts = null)
    public ObjectSystemExternalresource(String name, ObjectSystemExternalresourceArgs args)
    public ObjectSystemExternalresource(String name, ObjectSystemExternalresourceArgs args, CustomResourceOptions options)
    
    type: fortimanager:ObjectSystemExternalresource
    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 ObjectSystemExternalresourceArgs
    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 ObjectSystemExternalresourceArgs
    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 ObjectSystemExternalresourceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ObjectSystemExternalresourceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ObjectSystemExternalresourceArgs
    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 objectSystemExternalresourceResource = new Fortimanager.ObjectSystemExternalresource("objectSystemExternalresourceResource", new()
    {
        AddressCommentField = "string",
        AddressDataField = "string",
        AddressNameField = "string",
        Adom = "string",
        Category = 0,
        ClientCertAuth = "string",
        ClientCerts = new[]
        {
            "string",
        },
        Comments = "string",
        DynamicMappings = new[]
        {
            new Fortimanager.Inputs.ObjectSystemExternalresourceDynamicMappingArgs
            {
                _scopes = new[]
                {
                    new Fortimanager.Inputs.ObjectSystemExternalresourceDynamicMapping_ScopeArgs
                    {
                        Name = "string",
                        Vdom = "string",
                    },
                },
                SourceIp = "string",
            },
        },
        DynamicSortSubtable = "string",
        Interface = "string",
        InterfaceSelectMethod = "string",
        Name = "string",
        Namespace = "string",
        ObjectArrayPath = "string",
        ObjectSystemExternalresourceId = "string",
        Passwords = new[]
        {
            "string",
        },
        RefreshRate = 0,
        Resource = "string",
        Scopetype = "string",
        ServerIdentityCheck = "string",
        SourceIp = "string",
        Status = "string",
        Type = "string",
        UpdateMethod = "string",
        UserAgent = "string",
        Username = "string",
        Uuid = "string",
        VrfSelect = 0,
    });
    
    example, err := fortimanager.NewObjectSystemExternalresource(ctx, "objectSystemExternalresourceResource", &fortimanager.ObjectSystemExternalresourceArgs{
    	AddressCommentField: pulumi.String("string"),
    	AddressDataField:    pulumi.String("string"),
    	AddressNameField:    pulumi.String("string"),
    	Adom:                pulumi.String("string"),
    	Category:            pulumi.Float64(0),
    	ClientCertAuth:      pulumi.String("string"),
    	ClientCerts: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Comments: pulumi.String("string"),
    	DynamicMappings: fortimanager.ObjectSystemExternalresourceDynamicMappingArray{
    		&fortimanager.ObjectSystemExternalresourceDynamicMappingArgs{
    			_scopes: fortimanager.ObjectSystemExternalresourceDynamicMapping_ScopeArray{
    				&fortimanager.ObjectSystemExternalresourceDynamicMapping_ScopeArgs{
    					Name: pulumi.String("string"),
    					Vdom: pulumi.String("string"),
    				},
    			},
    			SourceIp: pulumi.String("string"),
    		},
    	},
    	DynamicSortSubtable:            pulumi.String("string"),
    	Interface:                      pulumi.String("string"),
    	InterfaceSelectMethod:          pulumi.String("string"),
    	Name:                           pulumi.String("string"),
    	Namespace:                      pulumi.String("string"),
    	ObjectArrayPath:                pulumi.String("string"),
    	ObjectSystemExternalresourceId: pulumi.String("string"),
    	Passwords: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	RefreshRate:         pulumi.Float64(0),
    	Resource:            pulumi.String("string"),
    	Scopetype:           pulumi.String("string"),
    	ServerIdentityCheck: pulumi.String("string"),
    	SourceIp:            pulumi.String("string"),
    	Status:              pulumi.String("string"),
    	Type:                pulumi.String("string"),
    	UpdateMethod:        pulumi.String("string"),
    	UserAgent:           pulumi.String("string"),
    	Username:            pulumi.String("string"),
    	Uuid:                pulumi.String("string"),
    	VrfSelect:           pulumi.Float64(0),
    })
    
    var objectSystemExternalresourceResource = new ObjectSystemExternalresource("objectSystemExternalresourceResource", ObjectSystemExternalresourceArgs.builder()
        .addressCommentField("string")
        .addressDataField("string")
        .addressNameField("string")
        .adom("string")
        .category(0)
        .clientCertAuth("string")
        .clientCerts("string")
        .comments("string")
        .dynamicMappings(ObjectSystemExternalresourceDynamicMappingArgs.builder()
            ._scopes(ObjectSystemExternalresourceDynamicMapping_ScopeArgs.builder()
                .name("string")
                .vdom("string")
                .build())
            .sourceIp("string")
            .build())
        .dynamicSortSubtable("string")
        .interface_("string")
        .interfaceSelectMethod("string")
        .name("string")
        .namespace("string")
        .objectArrayPath("string")
        .objectSystemExternalresourceId("string")
        .passwords("string")
        .refreshRate(0)
        .resource("string")
        .scopetype("string")
        .serverIdentityCheck("string")
        .sourceIp("string")
        .status("string")
        .type("string")
        .updateMethod("string")
        .userAgent("string")
        .username("string")
        .uuid("string")
        .vrfSelect(0)
        .build());
    
    object_system_externalresource_resource = fortimanager.ObjectSystemExternalresource("objectSystemExternalresourceResource",
        address_comment_field="string",
        address_data_field="string",
        address_name_field="string",
        adom="string",
        category=0,
        client_cert_auth="string",
        client_certs=["string"],
        comments="string",
        dynamic_mappings=[{
            "_scopes": [{
                "name": "string",
                "vdom": "string",
            }],
            "source_ip": "string",
        }],
        dynamic_sort_subtable="string",
        interface="string",
        interface_select_method="string",
        name="string",
        namespace="string",
        object_array_path="string",
        object_system_externalresource_id="string",
        passwords=["string"],
        refresh_rate=0,
        resource="string",
        scopetype="string",
        server_identity_check="string",
        source_ip="string",
        status="string",
        type="string",
        update_method="string",
        user_agent="string",
        username="string",
        uuid="string",
        vrf_select=0)
    
    const objectSystemExternalresourceResource = new fortimanager.ObjectSystemExternalresource("objectSystemExternalresourceResource", {
        addressCommentField: "string",
        addressDataField: "string",
        addressNameField: "string",
        adom: "string",
        category: 0,
        clientCertAuth: "string",
        clientCerts: ["string"],
        comments: "string",
        dynamicMappings: [{
            _scopes: [{
                name: "string",
                vdom: "string",
            }],
            sourceIp: "string",
        }],
        dynamicSortSubtable: "string",
        "interface": "string",
        interfaceSelectMethod: "string",
        name: "string",
        namespace: "string",
        objectArrayPath: "string",
        objectSystemExternalresourceId: "string",
        passwords: ["string"],
        refreshRate: 0,
        resource: "string",
        scopetype: "string",
        serverIdentityCheck: "string",
        sourceIp: "string",
        status: "string",
        type: "string",
        updateMethod: "string",
        userAgent: "string",
        username: "string",
        uuid: "string",
        vrfSelect: 0,
    });
    
    type: fortimanager:ObjectSystemExternalresource
    properties:
        addressCommentField: string
        addressDataField: string
        addressNameField: string
        adom: string
        category: 0
        clientCertAuth: string
        clientCerts:
            - string
        comments: string
        dynamicMappings:
            - _scopes:
                - name: string
                  vdom: string
              sourceIp: string
        dynamicSortSubtable: string
        interface: string
        interfaceSelectMethod: string
        name: string
        namespace: string
        objectArrayPath: string
        objectSystemExternalresourceId: string
        passwords:
            - string
        refreshRate: 0
        resource: string
        scopetype: string
        serverIdentityCheck: string
        sourceIp: string
        status: string
        type: string
        updateMethod: string
        userAgent: string
        username: string
        uuid: string
        vrfSelect: 0
    

    ObjectSystemExternalresource 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 ObjectSystemExternalresource resource accepts the following input properties:

    AddressCommentField string
    JSON Path to address description in generic address entry.
    AddressDataField string
    JSON Path to address data in generic address entry.
    AddressNameField string
    JSON Path to address name in generic address entry.
    Adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    Category double
    User resource category.
    ClientCertAuth string
    Enable/disable using client certificate for TLS authentication. Valid values: disable, enable.
    ClientCerts List<string>
    Client certificate name.
    Comments string
    Comment.
    DynamicMappings List<ObjectSystemExternalresourceDynamicMapping>
    Dynamic_Mapping. The structure of dynamic_mapping block is documented below.
    DynamicSortSubtable string
    true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
    Interface string
    Specify outgoing interface to reach server.
    InterfaceSelectMethod string
    Specify how to select outgoing interface to reach server. Valid values: auto, sdwan, specify.
    Name string
    External resource name.
    Namespace string
    Generic external connector address namespace.
    ObjectArrayPath string
    JSON Path to array of generic addresses in resource.
    ObjectSystemExternalresourceId string
    an identifier for the resource with format {{name}}.
    Passwords List<string>
    HTTP basic authentication password.
    RefreshRate double
    Time interval to refresh external resource (1 - 43200 min, default = 5 min).
    Resource string
    URI of external resource.
    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.
    ServerIdentityCheck string
    Certificate verification option. Valid values: none, basic, full.
    SourceIp string
    Source IPv4 address used to communicate with server.
    Status string
    Enable/disable user resource. Valid values: disable, enable.
    Type string
    User resource type. Valid values: category, address, domain, malware.
    UpdateMethod string
    External resource update method. Valid values: feed, push.
    UserAgent string
    Override HTTP User-Agent header used when retrieving this external resource.
    Username string
    HTTP basic authentication user name.
    Uuid string
    Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
    VrfSelect double
    VRF ID used for connection to server.
    AddressCommentField string
    JSON Path to address description in generic address entry.
    AddressDataField string
    JSON Path to address data in generic address entry.
    AddressNameField string
    JSON Path to address name in generic address entry.
    Adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    Category float64
    User resource category.
    ClientCertAuth string
    Enable/disable using client certificate for TLS authentication. Valid values: disable, enable.
    ClientCerts []string
    Client certificate name.
    Comments string
    Comment.
    DynamicMappings []ObjectSystemExternalresourceDynamicMappingArgs
    Dynamic_Mapping. The structure of dynamic_mapping block is documented below.
    DynamicSortSubtable string
    true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
    Interface string
    Specify outgoing interface to reach server.
    InterfaceSelectMethod string
    Specify how to select outgoing interface to reach server. Valid values: auto, sdwan, specify.
    Name string
    External resource name.
    Namespace string
    Generic external connector address namespace.
    ObjectArrayPath string
    JSON Path to array of generic addresses in resource.
    ObjectSystemExternalresourceId string
    an identifier for the resource with format {{name}}.
    Passwords []string
    HTTP basic authentication password.
    RefreshRate float64
    Time interval to refresh external resource (1 - 43200 min, default = 5 min).
    Resource string
    URI of external resource.
    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.
    ServerIdentityCheck string
    Certificate verification option. Valid values: none, basic, full.
    SourceIp string
    Source IPv4 address used to communicate with server.
    Status string
    Enable/disable user resource. Valid values: disable, enable.
    Type string
    User resource type. Valid values: category, address, domain, malware.
    UpdateMethod string
    External resource update method. Valid values: feed, push.
    UserAgent string
    Override HTTP User-Agent header used when retrieving this external resource.
    Username string
    HTTP basic authentication user name.
    Uuid string
    Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
    VrfSelect float64
    VRF ID used for connection to server.
    addressCommentField String
    JSON Path to address description in generic address entry.
    addressDataField String
    JSON Path to address data in generic address entry.
    addressNameField String
    JSON Path to address name in generic address entry.
    adom String
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    category Double
    User resource category.
    clientCertAuth String
    Enable/disable using client certificate for TLS authentication. Valid values: disable, enable.
    clientCerts List<String>
    Client certificate name.
    comments String
    Comment.
    dynamicMappings List<ObjectSystemExternalresourceDynamicMapping>
    Dynamic_Mapping. The structure of dynamic_mapping block is documented below.
    dynamicSortSubtable String
    true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
    interfaceSelectMethod String
    Specify how to select outgoing interface to reach server. Valid values: auto, sdwan, specify.
    interface_ String
    Specify outgoing interface to reach server.
    name String
    External resource name.
    namespace String
    Generic external connector address namespace.
    objectArrayPath String
    JSON Path to array of generic addresses in resource.
    objectSystemExternalresourceId String
    an identifier for the resource with format {{name}}.
    passwords List<String>
    HTTP basic authentication password.
    refreshRate Double
    Time interval to refresh external resource (1 - 43200 min, default = 5 min).
    resource String
    URI of external resource.
    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.
    serverIdentityCheck String
    Certificate verification option. Valid values: none, basic, full.
    sourceIp String
    Source IPv4 address used to communicate with server.
    status String
    Enable/disable user resource. Valid values: disable, enable.
    type String
    User resource type. Valid values: category, address, domain, malware.
    updateMethod String
    External resource update method. Valid values: feed, push.
    userAgent String
    Override HTTP User-Agent header used when retrieving this external resource.
    username String
    HTTP basic authentication user name.
    uuid String
    Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
    vrfSelect Double
    VRF ID used for connection to server.
    addressCommentField string
    JSON Path to address description in generic address entry.
    addressDataField string
    JSON Path to address data in generic address entry.
    addressNameField string
    JSON Path to address name in generic address entry.
    adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    category number
    User resource category.
    clientCertAuth string
    Enable/disable using client certificate for TLS authentication. Valid values: disable, enable.
    clientCerts string[]
    Client certificate name.
    comments string
    Comment.
    dynamicMappings ObjectSystemExternalresourceDynamicMapping[]
    Dynamic_Mapping. The structure of dynamic_mapping block is documented below.
    dynamicSortSubtable string
    true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
    interface string
    Specify outgoing interface to reach server.
    interfaceSelectMethod string
    Specify how to select outgoing interface to reach server. Valid values: auto, sdwan, specify.
    name string
    External resource name.
    namespace string
    Generic external connector address namespace.
    objectArrayPath string
    JSON Path to array of generic addresses in resource.
    objectSystemExternalresourceId string
    an identifier for the resource with format {{name}}.
    passwords string[]
    HTTP basic authentication password.
    refreshRate number
    Time interval to refresh external resource (1 - 43200 min, default = 5 min).
    resource string
    URI of external resource.
    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.
    serverIdentityCheck string
    Certificate verification option. Valid values: none, basic, full.
    sourceIp string
    Source IPv4 address used to communicate with server.
    status string
    Enable/disable user resource. Valid values: disable, enable.
    type string
    User resource type. Valid values: category, address, domain, malware.
    updateMethod string
    External resource update method. Valid values: feed, push.
    userAgent string
    Override HTTP User-Agent header used when retrieving this external resource.
    username string
    HTTP basic authentication user name.
    uuid string
    Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
    vrfSelect number
    VRF ID used for connection to server.
    address_comment_field str
    JSON Path to address description in generic address entry.
    address_data_field str
    JSON Path to address data in generic address entry.
    address_name_field str
    JSON Path to address name in generic address entry.
    adom str
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    category float
    User resource category.
    client_cert_auth str
    Enable/disable using client certificate for TLS authentication. Valid values: disable, enable.
    client_certs Sequence[str]
    Client certificate name.
    comments str
    Comment.
    dynamic_mappings Sequence[ObjectSystemExternalresourceDynamicMappingArgs]
    Dynamic_Mapping. The structure of dynamic_mapping block is documented below.
    dynamic_sort_subtable str
    true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
    interface str
    Specify outgoing interface to reach server.
    interface_select_method str
    Specify how to select outgoing interface to reach server. Valid values: auto, sdwan, specify.
    name str
    External resource name.
    namespace str
    Generic external connector address namespace.
    object_array_path str
    JSON Path to array of generic addresses in resource.
    object_system_externalresource_id str
    an identifier for the resource with format {{name}}.
    passwords Sequence[str]
    HTTP basic authentication password.
    refresh_rate float
    Time interval to refresh external resource (1 - 43200 min, default = 5 min).
    resource str
    URI of external resource.
    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.
    server_identity_check str
    Certificate verification option. Valid values: none, basic, full.
    source_ip str
    Source IPv4 address used to communicate with server.
    status str
    Enable/disable user resource. Valid values: disable, enable.
    type str
    User resource type. Valid values: category, address, domain, malware.
    update_method str
    External resource update method. Valid values: feed, push.
    user_agent str
    Override HTTP User-Agent header used when retrieving this external resource.
    username str
    HTTP basic authentication user name.
    uuid str
    Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
    vrf_select float
    VRF ID used for connection to server.
    addressCommentField String
    JSON Path to address description in generic address entry.
    addressDataField String
    JSON Path to address data in generic address entry.
    addressNameField String
    JSON Path to address name in generic address entry.
    adom String
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    category Number
    User resource category.
    clientCertAuth String
    Enable/disable using client certificate for TLS authentication. Valid values: disable, enable.
    clientCerts List<String>
    Client certificate name.
    comments String
    Comment.
    dynamicMappings List<Property Map>
    Dynamic_Mapping. The structure of dynamic_mapping block is documented below.
    dynamicSortSubtable String
    true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
    interface String
    Specify outgoing interface to reach server.
    interfaceSelectMethod String
    Specify how to select outgoing interface to reach server. Valid values: auto, sdwan, specify.
    name String
    External resource name.
    namespace String
    Generic external connector address namespace.
    objectArrayPath String
    JSON Path to array of generic addresses in resource.
    objectSystemExternalresourceId String
    an identifier for the resource with format {{name}}.
    passwords List<String>
    HTTP basic authentication password.
    refreshRate Number
    Time interval to refresh external resource (1 - 43200 min, default = 5 min).
    resource String
    URI of external resource.
    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.
    serverIdentityCheck String
    Certificate verification option. Valid values: none, basic, full.
    sourceIp String
    Source IPv4 address used to communicate with server.
    status String
    Enable/disable user resource. Valid values: disable, enable.
    type String
    User resource type. Valid values: category, address, domain, malware.
    updateMethod String
    External resource update method. Valid values: feed, push.
    userAgent String
    Override HTTP User-Agent header used when retrieving this external resource.
    username String
    HTTP basic authentication user name.
    uuid String
    Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
    vrfSelect Number
    VRF ID used for connection to server.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ObjectSystemExternalresource 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 ObjectSystemExternalresource Resource

    Get an existing ObjectSystemExternalresource 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?: ObjectSystemExternalresourceState, opts?: CustomResourceOptions): ObjectSystemExternalresource
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            address_comment_field: Optional[str] = None,
            address_data_field: Optional[str] = None,
            address_name_field: Optional[str] = None,
            adom: Optional[str] = None,
            category: Optional[float] = None,
            client_cert_auth: Optional[str] = None,
            client_certs: Optional[Sequence[str]] = None,
            comments: Optional[str] = None,
            dynamic_mappings: Optional[Sequence[ObjectSystemExternalresourceDynamicMappingArgs]] = None,
            dynamic_sort_subtable: Optional[str] = None,
            interface: Optional[str] = None,
            interface_select_method: Optional[str] = None,
            name: Optional[str] = None,
            namespace: Optional[str] = None,
            object_array_path: Optional[str] = None,
            object_system_externalresource_id: Optional[str] = None,
            passwords: Optional[Sequence[str]] = None,
            refresh_rate: Optional[float] = None,
            resource: Optional[str] = None,
            scopetype: Optional[str] = None,
            server_identity_check: Optional[str] = None,
            source_ip: Optional[str] = None,
            status: Optional[str] = None,
            type: Optional[str] = None,
            update_method: Optional[str] = None,
            user_agent: Optional[str] = None,
            username: Optional[str] = None,
            uuid: Optional[str] = None,
            vrf_select: Optional[float] = None) -> ObjectSystemExternalresource
    func GetObjectSystemExternalresource(ctx *Context, name string, id IDInput, state *ObjectSystemExternalresourceState, opts ...ResourceOption) (*ObjectSystemExternalresource, error)
    public static ObjectSystemExternalresource Get(string name, Input<string> id, ObjectSystemExternalresourceState? state, CustomResourceOptions? opts = null)
    public static ObjectSystemExternalresource get(String name, Output<String> id, ObjectSystemExternalresourceState state, CustomResourceOptions options)
    resources:  _:    type: fortimanager:ObjectSystemExternalresource    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:
    AddressCommentField string
    JSON Path to address description in generic address entry.
    AddressDataField string
    JSON Path to address data in generic address entry.
    AddressNameField string
    JSON Path to address name in generic address entry.
    Adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    Category double
    User resource category.
    ClientCertAuth string
    Enable/disable using client certificate for TLS authentication. Valid values: disable, enable.
    ClientCerts List<string>
    Client certificate name.
    Comments string
    Comment.
    DynamicMappings List<ObjectSystemExternalresourceDynamicMapping>
    Dynamic_Mapping. The structure of dynamic_mapping block is documented below.
    DynamicSortSubtable string
    true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
    Interface string
    Specify outgoing interface to reach server.
    InterfaceSelectMethod string
    Specify how to select outgoing interface to reach server. Valid values: auto, sdwan, specify.
    Name string
    External resource name.
    Namespace string
    Generic external connector address namespace.
    ObjectArrayPath string
    JSON Path to array of generic addresses in resource.
    ObjectSystemExternalresourceId string
    an identifier for the resource with format {{name}}.
    Passwords List<string>
    HTTP basic authentication password.
    RefreshRate double
    Time interval to refresh external resource (1 - 43200 min, default = 5 min).
    Resource string
    URI of external resource.
    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.
    ServerIdentityCheck string
    Certificate verification option. Valid values: none, basic, full.
    SourceIp string
    Source IPv4 address used to communicate with server.
    Status string
    Enable/disable user resource. Valid values: disable, enable.
    Type string
    User resource type. Valid values: category, address, domain, malware.
    UpdateMethod string
    External resource update method. Valid values: feed, push.
    UserAgent string
    Override HTTP User-Agent header used when retrieving this external resource.
    Username string
    HTTP basic authentication user name.
    Uuid string
    Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
    VrfSelect double
    VRF ID used for connection to server.
    AddressCommentField string
    JSON Path to address description in generic address entry.
    AddressDataField string
    JSON Path to address data in generic address entry.
    AddressNameField string
    JSON Path to address name in generic address entry.
    Adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    Category float64
    User resource category.
    ClientCertAuth string
    Enable/disable using client certificate for TLS authentication. Valid values: disable, enable.
    ClientCerts []string
    Client certificate name.
    Comments string
    Comment.
    DynamicMappings []ObjectSystemExternalresourceDynamicMappingArgs
    Dynamic_Mapping. The structure of dynamic_mapping block is documented below.
    DynamicSortSubtable string
    true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
    Interface string
    Specify outgoing interface to reach server.
    InterfaceSelectMethod string
    Specify how to select outgoing interface to reach server. Valid values: auto, sdwan, specify.
    Name string
    External resource name.
    Namespace string
    Generic external connector address namespace.
    ObjectArrayPath string
    JSON Path to array of generic addresses in resource.
    ObjectSystemExternalresourceId string
    an identifier for the resource with format {{name}}.
    Passwords []string
    HTTP basic authentication password.
    RefreshRate float64
    Time interval to refresh external resource (1 - 43200 min, default = 5 min).
    Resource string
    URI of external resource.
    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.
    ServerIdentityCheck string
    Certificate verification option. Valid values: none, basic, full.
    SourceIp string
    Source IPv4 address used to communicate with server.
    Status string
    Enable/disable user resource. Valid values: disable, enable.
    Type string
    User resource type. Valid values: category, address, domain, malware.
    UpdateMethod string
    External resource update method. Valid values: feed, push.
    UserAgent string
    Override HTTP User-Agent header used when retrieving this external resource.
    Username string
    HTTP basic authentication user name.
    Uuid string
    Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
    VrfSelect float64
    VRF ID used for connection to server.
    addressCommentField String
    JSON Path to address description in generic address entry.
    addressDataField String
    JSON Path to address data in generic address entry.
    addressNameField String
    JSON Path to address name in generic address entry.
    adom String
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    category Double
    User resource category.
    clientCertAuth String
    Enable/disable using client certificate for TLS authentication. Valid values: disable, enable.
    clientCerts List<String>
    Client certificate name.
    comments String
    Comment.
    dynamicMappings List<ObjectSystemExternalresourceDynamicMapping>
    Dynamic_Mapping. The structure of dynamic_mapping block is documented below.
    dynamicSortSubtable String
    true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
    interfaceSelectMethod String
    Specify how to select outgoing interface to reach server. Valid values: auto, sdwan, specify.
    interface_ String
    Specify outgoing interface to reach server.
    name String
    External resource name.
    namespace String
    Generic external connector address namespace.
    objectArrayPath String
    JSON Path to array of generic addresses in resource.
    objectSystemExternalresourceId String
    an identifier for the resource with format {{name}}.
    passwords List<String>
    HTTP basic authentication password.
    refreshRate Double
    Time interval to refresh external resource (1 - 43200 min, default = 5 min).
    resource String
    URI of external resource.
    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.
    serverIdentityCheck String
    Certificate verification option. Valid values: none, basic, full.
    sourceIp String
    Source IPv4 address used to communicate with server.
    status String
    Enable/disable user resource. Valid values: disable, enable.
    type String
    User resource type. Valid values: category, address, domain, malware.
    updateMethod String
    External resource update method. Valid values: feed, push.
    userAgent String
    Override HTTP User-Agent header used when retrieving this external resource.
    username String
    HTTP basic authentication user name.
    uuid String
    Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
    vrfSelect Double
    VRF ID used for connection to server.
    addressCommentField string
    JSON Path to address description in generic address entry.
    addressDataField string
    JSON Path to address data in generic address entry.
    addressNameField string
    JSON Path to address name in generic address entry.
    adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    category number
    User resource category.
    clientCertAuth string
    Enable/disable using client certificate for TLS authentication. Valid values: disable, enable.
    clientCerts string[]
    Client certificate name.
    comments string
    Comment.
    dynamicMappings ObjectSystemExternalresourceDynamicMapping[]
    Dynamic_Mapping. The structure of dynamic_mapping block is documented below.
    dynamicSortSubtable string
    true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
    interface string
    Specify outgoing interface to reach server.
    interfaceSelectMethod string
    Specify how to select outgoing interface to reach server. Valid values: auto, sdwan, specify.
    name string
    External resource name.
    namespace string
    Generic external connector address namespace.
    objectArrayPath string
    JSON Path to array of generic addresses in resource.
    objectSystemExternalresourceId string
    an identifier for the resource with format {{name}}.
    passwords string[]
    HTTP basic authentication password.
    refreshRate number
    Time interval to refresh external resource (1 - 43200 min, default = 5 min).
    resource string
    URI of external resource.
    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.
    serverIdentityCheck string
    Certificate verification option. Valid values: none, basic, full.
    sourceIp string
    Source IPv4 address used to communicate with server.
    status string
    Enable/disable user resource. Valid values: disable, enable.
    type string
    User resource type. Valid values: category, address, domain, malware.
    updateMethod string
    External resource update method. Valid values: feed, push.
    userAgent string
    Override HTTP User-Agent header used when retrieving this external resource.
    username string
    HTTP basic authentication user name.
    uuid string
    Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
    vrfSelect number
    VRF ID used for connection to server.
    address_comment_field str
    JSON Path to address description in generic address entry.
    address_data_field str
    JSON Path to address data in generic address entry.
    address_name_field str
    JSON Path to address name in generic address entry.
    adom str
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    category float
    User resource category.
    client_cert_auth str
    Enable/disable using client certificate for TLS authentication. Valid values: disable, enable.
    client_certs Sequence[str]
    Client certificate name.
    comments str
    Comment.
    dynamic_mappings Sequence[ObjectSystemExternalresourceDynamicMappingArgs]
    Dynamic_Mapping. The structure of dynamic_mapping block is documented below.
    dynamic_sort_subtable str
    true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
    interface str
    Specify outgoing interface to reach server.
    interface_select_method str
    Specify how to select outgoing interface to reach server. Valid values: auto, sdwan, specify.
    name str
    External resource name.
    namespace str
    Generic external connector address namespace.
    object_array_path str
    JSON Path to array of generic addresses in resource.
    object_system_externalresource_id str
    an identifier for the resource with format {{name}}.
    passwords Sequence[str]
    HTTP basic authentication password.
    refresh_rate float
    Time interval to refresh external resource (1 - 43200 min, default = 5 min).
    resource str
    URI of external resource.
    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.
    server_identity_check str
    Certificate verification option. Valid values: none, basic, full.
    source_ip str
    Source IPv4 address used to communicate with server.
    status str
    Enable/disable user resource. Valid values: disable, enable.
    type str
    User resource type. Valid values: category, address, domain, malware.
    update_method str
    External resource update method. Valid values: feed, push.
    user_agent str
    Override HTTP User-Agent header used when retrieving this external resource.
    username str
    HTTP basic authentication user name.
    uuid str
    Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
    vrf_select float
    VRF ID used for connection to server.
    addressCommentField String
    JSON Path to address description in generic address entry.
    addressDataField String
    JSON Path to address data in generic address entry.
    addressNameField String
    JSON Path to address name in generic address entry.
    adom String
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    category Number
    User resource category.
    clientCertAuth String
    Enable/disable using client certificate for TLS authentication. Valid values: disable, enable.
    clientCerts List<String>
    Client certificate name.
    comments String
    Comment.
    dynamicMappings List<Property Map>
    Dynamic_Mapping. The structure of dynamic_mapping block is documented below.
    dynamicSortSubtable String
    true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
    interface String
    Specify outgoing interface to reach server.
    interfaceSelectMethod String
    Specify how to select outgoing interface to reach server. Valid values: auto, sdwan, specify.
    name String
    External resource name.
    namespace String
    Generic external connector address namespace.
    objectArrayPath String
    JSON Path to array of generic addresses in resource.
    objectSystemExternalresourceId String
    an identifier for the resource with format {{name}}.
    passwords List<String>
    HTTP basic authentication password.
    refreshRate Number
    Time interval to refresh external resource (1 - 43200 min, default = 5 min).
    resource String
    URI of external resource.
    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.
    serverIdentityCheck String
    Certificate verification option. Valid values: none, basic, full.
    sourceIp String
    Source IPv4 address used to communicate with server.
    status String
    Enable/disable user resource. Valid values: disable, enable.
    type String
    User resource type. Valid values: category, address, domain, malware.
    updateMethod String
    External resource update method. Valid values: feed, push.
    userAgent String
    Override HTTP User-Agent header used when retrieving this external resource.
    username String
    HTTP basic authentication user name.
    uuid String
    Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
    vrfSelect Number
    VRF ID used for connection to server.

    Supporting Types

    ObjectSystemExternalresourceDynamicMapping, ObjectSystemExternalresourceDynamicMappingArgs

    SourceIp string
    Source-Ip.
    _scopes List<ObjectSystemExternalresourceDynamicMapping_Scope>
    _Scope. The structure of _scope block is documented below.
    SourceIp string
    Source-Ip.
    _scopes []ObjectSystemExternalresourceDynamicMapping_Scope
    _Scope. The structure of _scope block is documented below.
    _scopes List<ObjectSystemExternalresourceDynamicMapping_Scope>
    _Scope. The structure of _scope block is documented below.
    sourceIp String
    Source-Ip.
    _scopes ObjectSystemExternalresourceDynamicMapping_Scope[]
    _Scope. The structure of _scope block is documented below.
    sourceIp string
    Source-Ip.
    _scopes Sequence[ObjectSystemExternalresourceDynamicMapping_Scope]
    _Scope. The structure of _scope block is documented below.
    source_ip str
    Source-Ip.
    _scopes List<Property Map>
    _Scope. The structure of _scope block is documented below.
    sourceIp String
    Source-Ip.

    ObjectSystemExternalresourceDynamicMapping_Scope, ObjectSystemExternalresourceDynamicMapping_ScopeArgs

    Name string
    Name.
    Vdom string
    Vdom.
    Name string
    Name.
    Vdom string
    Vdom.
    name String
    Name.
    vdom String
    Vdom.
    name string
    Name.
    vdom string
    Vdom.
    name str
    Name.
    vdom str
    Vdom.
    name String
    Name.
    vdom String
    Vdom.

    Import

    ObjectSystem ExternalResource can be imported using any of these accepted formats:

    $ export “FORTIMANAGER_IMPORT_TABLE”=“true”

    $ pulumi import fortimanager:index/objectSystemExternalresource:ObjectSystemExternalresource 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.14.0 published on Tuesday, Apr 15, 2025 by fortinetdev