published on Friday, Jul 31, 2026 by fortinetdev
published on Friday, Jul 31, 2026 by fortinetdev
Define custom tag table.
Create ObjectFirewallCustomtag Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ObjectFirewallCustomtag(name: string, args?: ObjectFirewallCustomtagArgs, opts?: CustomResourceOptions);@overload
def ObjectFirewallCustomtag(resource_name: str,
args: Optional[ObjectFirewallCustomtagArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def ObjectFirewallCustomtag(resource_name: str,
opts: Optional[ResourceOptions] = None,
abbreviation: Optional[str] = None,
adom: Optional[str] = None,
color: Optional[float] = None,
comment: Optional[str] = None,
fabric_force_sync: Optional[str] = None,
fabric_object: Optional[str] = None,
fabric_object_source: Optional[str] = None,
name: Optional[str] = None,
object_firewall_customtag_id: Optional[str] = None,
scopetype: Optional[str] = None,
update_if_exist: Optional[bool] = None,
uuid: Optional[str] = None)func NewObjectFirewallCustomtag(ctx *Context, name string, args *ObjectFirewallCustomtagArgs, opts ...ResourceOption) (*ObjectFirewallCustomtag, error)public ObjectFirewallCustomtag(string name, ObjectFirewallCustomtagArgs? args = null, CustomResourceOptions? opts = null)
public ObjectFirewallCustomtag(String name, ObjectFirewallCustomtagArgs args)
public ObjectFirewallCustomtag(String name, ObjectFirewallCustomtagArgs args, CustomResourceOptions options)
type: fortimanager:ObjectFirewallCustomtag
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "fortimanager_object_firewall_customtag" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args ObjectFirewallCustomtagArgs
- 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 ObjectFirewallCustomtagArgs
- 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 ObjectFirewallCustomtagArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ObjectFirewallCustomtagArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ObjectFirewallCustomtagArgs
- 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 objectFirewallCustomtagResource = new Fortimanager.ObjectFirewallCustomtag("objectFirewallCustomtagResource", new()
{
Abbreviation = "string",
Adom = "string",
Color = 0,
Comment = "string",
FabricForceSync = "string",
FabricObject = "string",
FabricObjectSource = "string",
Name = "string",
ObjectFirewallCustomtagId = "string",
Scopetype = "string",
UpdateIfExist = false,
Uuid = "string",
});
example, err := fortimanager.NewObjectFirewallCustomtag(ctx, "objectFirewallCustomtagResource", &fortimanager.ObjectFirewallCustomtagArgs{
Abbreviation: pulumi.String("string"),
Adom: pulumi.String("string"),
Color: pulumi.Float64(0),
Comment: pulumi.String("string"),
FabricForceSync: pulumi.String("string"),
FabricObject: pulumi.String("string"),
FabricObjectSource: pulumi.String("string"),
Name: pulumi.String("string"),
ObjectFirewallCustomtagId: pulumi.String("string"),
Scopetype: pulumi.String("string"),
UpdateIfExist: pulumi.Bool(false),
Uuid: pulumi.String("string"),
})
resource "fortimanager_object_firewall_customtag" "objectFirewallCustomtagResource" {
lifecycle {
create_before_destroy = true
}
abbreviation = "string"
adom = "string"
color = 0
comment = "string"
fabric_force_sync = "string"
fabric_object = "string"
fabric_object_source = "string"
name = "string"
object_firewall_customtag_id = "string"
scopetype = "string"
update_if_exist = false
uuid = "string"
}
var objectFirewallCustomtagResource = new ObjectFirewallCustomtag("objectFirewallCustomtagResource", ObjectFirewallCustomtagArgs.builder()
.abbreviation("string")
.adom("string")
.color(0.0)
.comment("string")
.fabricForceSync("string")
.fabricObject("string")
.fabricObjectSource("string")
.name("string")
.objectFirewallCustomtagId("string")
.scopetype("string")
.updateIfExist(false)
.uuid("string")
.build());
object_firewall_customtag_resource = fortimanager.ObjectFirewallCustomtag("objectFirewallCustomtagResource",
abbreviation="string",
adom="string",
color=float(0),
comment="string",
fabric_force_sync="string",
fabric_object="string",
fabric_object_source="string",
name="string",
object_firewall_customtag_id="string",
scopetype="string",
update_if_exist=False,
uuid="string")
const objectFirewallCustomtagResource = new fortimanager.ObjectFirewallCustomtag("objectFirewallCustomtagResource", {
abbreviation: "string",
adom: "string",
color: 0,
comment: "string",
fabricForceSync: "string",
fabricObject: "string",
fabricObjectSource: "string",
name: "string",
objectFirewallCustomtagId: "string",
scopetype: "string",
updateIfExist: false,
uuid: "string",
});
type: fortimanager:ObjectFirewallCustomtag
properties:
abbreviation: string
adom: string
color: 0
comment: string
fabricForceSync: string
fabricObject: string
fabricObjectSource: string
name: string
objectFirewallCustomtagId: string
scopetype: string
updateIfExist: false
uuid: string
ObjectFirewallCustomtag 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 ObjectFirewallCustomtag resource accepts the following input properties:
- Abbreviation string
- Custom tag name abbreviation.
- Adom string
- Adom. This value is valid only when the
scopetypeisadom, otherwise the value of adom in the provider will be inherited. - Color double
- Color of the custom tag on the GUI.
- Comment string
- Comment.
- Fabric
Force stringSync - Enable/disable forced synchronization of configuration objects from the root FortiGate unit to the downstream devices. Configuration conflict check is skipped. Valid values:
disable,enable. - Fabric
Object string - Security Fabric global object setting. Valid values:
disable,enable. - Fabric
Object stringSource - Source of truth for fabric object. Valid values:
member,local,root. - Name string
- Custom tag name.
- Object
Firewall stringCustomtag Id - an identifier for the resource with format {{name}}.
- Scopetype string
- The scope of application of the resource. Valid values:
inherit,adom,global. Theinheritmeans that the scopetype of the provider will be inherited, and adom will also be inherited. The default value isinherit. - Update
If boolExist - Uuid string
- Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
- Abbreviation string
- Custom tag name abbreviation.
- Adom string
- Adom. This value is valid only when the
scopetypeisadom, otherwise the value of adom in the provider will be inherited. - Color float64
- Color of the custom tag on the GUI.
- Comment string
- Comment.
- Fabric
Force stringSync - Enable/disable forced synchronization of configuration objects from the root FortiGate unit to the downstream devices. Configuration conflict check is skipped. Valid values:
disable,enable. - Fabric
Object string - Security Fabric global object setting. Valid values:
disable,enable. - Fabric
Object stringSource - Source of truth for fabric object. Valid values:
member,local,root. - Name string
- Custom tag name.
- Object
Firewall stringCustomtag Id - an identifier for the resource with format {{name}}.
- Scopetype string
- The scope of application of the resource. Valid values:
inherit,adom,global. Theinheritmeans that the scopetype of the provider will be inherited, and adom will also be inherited. The default value isinherit. - Update
If boolExist - Uuid string
- Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
- abbreviation string
- Custom tag name abbreviation.
- adom string
- Adom. This value is valid only when the
scopetypeisadom, otherwise the value of adom in the provider will be inherited. - color number
- Color of the custom tag on the GUI.
- comment string
- Comment.
- fabric_
force_ stringsync - Enable/disable forced synchronization of configuration objects from the root FortiGate unit to the downstream devices. Configuration conflict check is skipped. Valid values:
disable,enable. - fabric_
object string - Security Fabric global object setting. Valid values:
disable,enable. - fabric_
object_ stringsource - Source of truth for fabric object. Valid values:
member,local,root. - name string
- Custom tag name.
- object_
firewall_ stringcustomtag_ id - an identifier for the resource with format {{name}}.
- scopetype string
- The scope of application of the resource. Valid values:
inherit,adom,global. Theinheritmeans that the scopetype of the provider will be inherited, and adom will also be inherited. The default value isinherit. - update_
if_ boolexist - uuid string
- Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
- abbreviation String
- Custom tag name abbreviation.
- adom String
- Adom. This value is valid only when the
scopetypeisadom, otherwise the value of adom in the provider will be inherited. - color Double
- Color of the custom tag on the GUI.
- comment String
- Comment.
- fabric
Force StringSync - Enable/disable forced synchronization of configuration objects from the root FortiGate unit to the downstream devices. Configuration conflict check is skipped. Valid values:
disable,enable. - fabric
Object String - Security Fabric global object setting. Valid values:
disable,enable. - fabric
Object StringSource - Source of truth for fabric object. Valid values:
member,local,root. - name String
- Custom tag name.
- object
Firewall StringCustomtag Id - an identifier for the resource with format {{name}}.
- scopetype String
- The scope of application of the resource. Valid values:
inherit,adom,global. Theinheritmeans that the scopetype of the provider will be inherited, and adom will also be inherited. The default value isinherit. - update
If BooleanExist - uuid String
- Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
- abbreviation string
- Custom tag name abbreviation.
- adom string
- Adom. This value is valid only when the
scopetypeisadom, otherwise the value of adom in the provider will be inherited. - color number
- Color of the custom tag on the GUI.
- comment string
- Comment.
- fabric
Force stringSync - Enable/disable forced synchronization of configuration objects from the root FortiGate unit to the downstream devices. Configuration conflict check is skipped. Valid values:
disable,enable. - fabric
Object string - Security Fabric global object setting. Valid values:
disable,enable. - fabric
Object stringSource - Source of truth for fabric object. Valid values:
member,local,root. - name string
- Custom tag name.
- object
Firewall stringCustomtag Id - an identifier for the resource with format {{name}}.
- scopetype string
- The scope of application of the resource. Valid values:
inherit,adom,global. Theinheritmeans that the scopetype of the provider will be inherited, and adom will also be inherited. The default value isinherit. - update
If booleanExist - uuid string
- Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
- abbreviation str
- Custom tag name abbreviation.
- adom str
- Adom. This value is valid only when the
scopetypeisadom, otherwise the value of adom in the provider will be inherited. - color float
- Color of the custom tag on the GUI.
- comment str
- Comment.
- fabric_
force_ strsync - Enable/disable forced synchronization of configuration objects from the root FortiGate unit to the downstream devices. Configuration conflict check is skipped. Valid values:
disable,enable. - fabric_
object str - Security Fabric global object setting. Valid values:
disable,enable. - fabric_
object_ strsource - Source of truth for fabric object. Valid values:
member,local,root. - name str
- Custom tag name.
- object_
firewall_ strcustomtag_ id - an identifier for the resource with format {{name}}.
- scopetype str
- The scope of application of the resource. Valid values:
inherit,adom,global. Theinheritmeans that the scopetype of the provider will be inherited, and adom will also be inherited. The default value isinherit. - update_
if_ boolexist - uuid str
- Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
- abbreviation String
- Custom tag name abbreviation.
- adom String
- Adom. This value is valid only when the
scopetypeisadom, otherwise the value of adom in the provider will be inherited. - color Number
- Color of the custom tag on the GUI.
- comment String
- Comment.
- fabric
Force StringSync - Enable/disable forced synchronization of configuration objects from the root FortiGate unit to the downstream devices. Configuration conflict check is skipped. Valid values:
disable,enable. - fabric
Object String - Security Fabric global object setting. Valid values:
disable,enable. - fabric
Object StringSource - Source of truth for fabric object. Valid values:
member,local,root. - name String
- Custom tag name.
- object
Firewall StringCustomtag Id - an identifier for the resource with format {{name}}.
- scopetype String
- The scope of application of the resource. Valid values:
inherit,adom,global. Theinheritmeans that the scopetype of the provider will be inherited, and adom will also be inherited. The default value isinherit. - update
If BooleanExist - uuid String
- Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
Outputs
All input properties are implicitly available as output properties. Additionally, the ObjectFirewallCustomtag 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 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 ObjectFirewallCustomtag Resource
Get an existing ObjectFirewallCustomtag 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?: ObjectFirewallCustomtagState, opts?: CustomResourceOptions): ObjectFirewallCustomtag@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
abbreviation: Optional[str] = None,
adom: Optional[str] = None,
color: Optional[float] = None,
comment: Optional[str] = None,
fabric_force_sync: Optional[str] = None,
fabric_object: Optional[str] = None,
fabric_object_source: Optional[str] = None,
name: Optional[str] = None,
object_firewall_customtag_id: Optional[str] = None,
scopetype: Optional[str] = None,
update_if_exist: Optional[bool] = None,
uuid: Optional[str] = None) -> ObjectFirewallCustomtagfunc GetObjectFirewallCustomtag(ctx *Context, name string, id IDInput, state *ObjectFirewallCustomtagState, opts ...ResourceOption) (*ObjectFirewallCustomtag, error)public static ObjectFirewallCustomtag Get(string name, Input<string> id, ObjectFirewallCustomtagState? state, CustomResourceOptions? opts = null)public static ObjectFirewallCustomtag get(String name, Output<String> id, ObjectFirewallCustomtagState state, CustomResourceOptions options)resources: _: type: fortimanager:ObjectFirewallCustomtag get: id: ${id}import {
to = fortimanager_object_firewall_customtag.example
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.
- Abbreviation string
- Custom tag name abbreviation.
- Adom string
- Adom. This value is valid only when the
scopetypeisadom, otherwise the value of adom in the provider will be inherited. - Color double
- Color of the custom tag on the GUI.
- Comment string
- Comment.
- Fabric
Force stringSync - Enable/disable forced synchronization of configuration objects from the root FortiGate unit to the downstream devices. Configuration conflict check is skipped. Valid values:
disable,enable. - Fabric
Object string - Security Fabric global object setting. Valid values:
disable,enable. - Fabric
Object stringSource - Source of truth for fabric object. Valid values:
member,local,root. - Name string
- Custom tag name.
- Object
Firewall stringCustomtag Id - an identifier for the resource with format {{name}}.
- Scopetype string
- The scope of application of the resource. Valid values:
inherit,adom,global. Theinheritmeans that the scopetype of the provider will be inherited, and adom will also be inherited. The default value isinherit. - Update
If boolExist - Uuid string
- Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
- Abbreviation string
- Custom tag name abbreviation.
- Adom string
- Adom. This value is valid only when the
scopetypeisadom, otherwise the value of adom in the provider will be inherited. - Color float64
- Color of the custom tag on the GUI.
- Comment string
- Comment.
- Fabric
Force stringSync - Enable/disable forced synchronization of configuration objects from the root FortiGate unit to the downstream devices. Configuration conflict check is skipped. Valid values:
disable,enable. - Fabric
Object string - Security Fabric global object setting. Valid values:
disable,enable. - Fabric
Object stringSource - Source of truth for fabric object. Valid values:
member,local,root. - Name string
- Custom tag name.
- Object
Firewall stringCustomtag Id - an identifier for the resource with format {{name}}.
- Scopetype string
- The scope of application of the resource. Valid values:
inherit,adom,global. Theinheritmeans that the scopetype of the provider will be inherited, and adom will also be inherited. The default value isinherit. - Update
If boolExist - Uuid string
- Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
- abbreviation string
- Custom tag name abbreviation.
- adom string
- Adom. This value is valid only when the
scopetypeisadom, otherwise the value of adom in the provider will be inherited. - color number
- Color of the custom tag on the GUI.
- comment string
- Comment.
- fabric_
force_ stringsync - Enable/disable forced synchronization of configuration objects from the root FortiGate unit to the downstream devices. Configuration conflict check is skipped. Valid values:
disable,enable. - fabric_
object string - Security Fabric global object setting. Valid values:
disable,enable. - fabric_
object_ stringsource - Source of truth for fabric object. Valid values:
member,local,root. - name string
- Custom tag name.
- object_
firewall_ stringcustomtag_ id - an identifier for the resource with format {{name}}.
- scopetype string
- The scope of application of the resource. Valid values:
inherit,adom,global. Theinheritmeans that the scopetype of the provider will be inherited, and adom will also be inherited. The default value isinherit. - update_
if_ boolexist - uuid string
- Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
- abbreviation String
- Custom tag name abbreviation.
- adom String
- Adom. This value is valid only when the
scopetypeisadom, otherwise the value of adom in the provider will be inherited. - color Double
- Color of the custom tag on the GUI.
- comment String
- Comment.
- fabric
Force StringSync - Enable/disable forced synchronization of configuration objects from the root FortiGate unit to the downstream devices. Configuration conflict check is skipped. Valid values:
disable,enable. - fabric
Object String - Security Fabric global object setting. Valid values:
disable,enable. - fabric
Object StringSource - Source of truth for fabric object. Valid values:
member,local,root. - name String
- Custom tag name.
- object
Firewall StringCustomtag Id - an identifier for the resource with format {{name}}.
- scopetype String
- The scope of application of the resource. Valid values:
inherit,adom,global. Theinheritmeans that the scopetype of the provider will be inherited, and adom will also be inherited. The default value isinherit. - update
If BooleanExist - uuid String
- Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
- abbreviation string
- Custom tag name abbreviation.
- adom string
- Adom. This value is valid only when the
scopetypeisadom, otherwise the value of adom in the provider will be inherited. - color number
- Color of the custom tag on the GUI.
- comment string
- Comment.
- fabric
Force stringSync - Enable/disable forced synchronization of configuration objects from the root FortiGate unit to the downstream devices. Configuration conflict check is skipped. Valid values:
disable,enable. - fabric
Object string - Security Fabric global object setting. Valid values:
disable,enable. - fabric
Object stringSource - Source of truth for fabric object. Valid values:
member,local,root. - name string
- Custom tag name.
- object
Firewall stringCustomtag Id - an identifier for the resource with format {{name}}.
- scopetype string
- The scope of application of the resource. Valid values:
inherit,adom,global. Theinheritmeans that the scopetype of the provider will be inherited, and adom will also be inherited. The default value isinherit. - update
If booleanExist - uuid string
- Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
- abbreviation str
- Custom tag name abbreviation.
- adom str
- Adom. This value is valid only when the
scopetypeisadom, otherwise the value of adom in the provider will be inherited. - color float
- Color of the custom tag on the GUI.
- comment str
- Comment.
- fabric_
force_ strsync - Enable/disable forced synchronization of configuration objects from the root FortiGate unit to the downstream devices. Configuration conflict check is skipped. Valid values:
disable,enable. - fabric_
object str - Security Fabric global object setting. Valid values:
disable,enable. - fabric_
object_ strsource - Source of truth for fabric object. Valid values:
member,local,root. - name str
- Custom tag name.
- object_
firewall_ strcustomtag_ id - an identifier for the resource with format {{name}}.
- scopetype str
- The scope of application of the resource. Valid values:
inherit,adom,global. Theinheritmeans that the scopetype of the provider will be inherited, and adom will also be inherited. The default value isinherit. - update_
if_ boolexist - uuid str
- Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
- abbreviation String
- Custom tag name abbreviation.
- adom String
- Adom. This value is valid only when the
scopetypeisadom, otherwise the value of adom in the provider will be inherited. - color Number
- Color of the custom tag on the GUI.
- comment String
- Comment.
- fabric
Force StringSync - Enable/disable forced synchronization of configuration objects from the root FortiGate unit to the downstream devices. Configuration conflict check is skipped. Valid values:
disable,enable. - fabric
Object String - Security Fabric global object setting. Valid values:
disable,enable. - fabric
Object StringSource - Source of truth for fabric object. Valid values:
member,local,root. - name String
- Custom tag name.
- object
Firewall StringCustomtag Id - an identifier for the resource with format {{name}}.
- scopetype String
- The scope of application of the resource. Valid values:
inherit,adom,global. Theinheritmeans that the scopetype of the provider will be inherited, and adom will also be inherited. The default value isinherit. - update
If BooleanExist - uuid String
- Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
Import
ObjectFirewall CustomTag can be imported using any of these accepted formats:
$ export “FORTIMANAGER_IMPORT_TABLE”=“true”
$ pulumi import fortimanager:index/objectFirewallCustomtag:ObjectFirewallCustomtag 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
fortimanagerTerraform Provider.
published on Friday, Jul 31, 2026 by fortinetdev