Fortios v0.0.5, Apr 9 24

Fortios v0.0.5 published on Tuesday, Apr 9, 2024 by pulumiverse

fortios.firewall.getAddress

Explore with Pulumi AI

Fortios v0.0.5 published on Tuesday, Apr 9, 2024 by pulumiverse

Using getAddress

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getAddress(args: GetAddressArgs, opts?: InvokeOptions): Promise<GetAddressResult>
function getAddressOutput(args: GetAddressOutputArgs, opts?: InvokeOptions): Output<GetAddressResult>

def get_address(name: Optional[str] = None,
                vdomparam: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetAddressResult
def get_address_output(name: Optional[pulumi.Input[str]] = None,
                vdomparam: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetAddressResult]

func LookupAddress(ctx *Context, args *LookupAddressArgs, opts ...InvokeOption) (*LookupAddressResult, error)
func LookupAddressOutput(ctx *Context, args *LookupAddressOutputArgs, opts ...InvokeOption) LookupAddressResultOutput

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

public static class GetAddress 
{
    public static Task<GetAddressResult> InvokeAsync(GetAddressArgs args, InvokeOptions? opts = null)
    public static Output<GetAddressResult> Invoke(GetAddressInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetAddressResult> getAddress(GetAddressArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: fortios:firewall/getAddress:getAddress
  arguments:
    # arguments dictionary

The following arguments are supported:

Name string: Specify the name of the desired firewall address.
Vdomparam string: Specifies the vdom to which the data source will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.

Name string: Specify the name of the desired firewall address.
Vdomparam string: Specifies the vdom to which the data source will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.

name String: Specify the name of the desired firewall address.
vdomparam String: Specifies the vdom to which the data source will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.

name string: Specify the name of the desired firewall address.
vdomparam string: Specifies the vdom to which the data source will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.

name str: Specify the name of the desired firewall address.
vdomparam str: Specifies the vdom to which the data source will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.

name String: Specify the name of the desired firewall address.
vdomparam String: Specifies the vdom to which the data source will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.

getAddress Result

The following output properties are available:

AllowRouting string: Enable/disable use of this address in the static route configuration.
AssociatedInterface string: Network interface associated with address.
CacheTtl int: Defines the minimal TTL of individual IP addresses in FQDN cache measured in seconds.
ClearpassSpt string: SPT (System Posture Token) value.
Color int: Color of icon on the GUI.
Comment string: Comment.
Country string: IP addresses associated to a specific country.
EndIp string: Final IP address (inclusive) in the range for the address.
EndMac string: Last MAC address in the range.
EpgName string: Endpoint group name.
FabricObject string: Security Fabric global object setting.
Filter string: Match criteria filter.
Fqdn string: Fully Qualified Domain Name address.
FssoGroups List<Pulumiverse.Fortios.Firewall.Outputs.GetAddressFssoGroup>: FSSO group(s). The structure of fsso_group block is documented below.
HwModel string: Dynamic address matching hardware model.
HwVendor string: Dynamic address matching hardware vendor.
Id string: The provider-assigned unique ID for this managed resource.
Interface string: Name of interface whose IP address is to be used.
Lists List<Pulumiverse.Fortios.Firewall.Outputs.GetAddressList>: IP address list. The structure of list block is documented below.
Macaddrs List<Pulumiverse.Fortios.Firewall.Outputs.GetAddressMacaddr>: MAC address ranges [-] separated by space.
Name string: Tag name.
NodeIpOnly string: Enable/disable collection of node addresses only in Kubernetes.
ObjId string: Object ID for NSX.
ObjTag string: Tag of dynamic address object.
ObjType string: Object type.
Organization string: Organization domain name (Syntax: organization/domain).
Os string: Dynamic address matching operating system.
PolicyGroup string: Policy group name.
RouteTag int: route-tag address.
Sdn string: SDN.
SdnAddrType string: Type of addresses to collect.
SdnTag string: SDN Tag.
StartIp string: First IP address (inclusive) in the range for the address.
StartMac string: First MAC address in the range.
SubType string: Sub-type of address.
Subnet string: IP address and subnet mask of address.
SubnetName string: Subnet name.
SwVersion string: Dynamic address matching software version.
TagDetectionLevel string: Tag detection level of dynamic address object.
TagType string: Tag type of dynamic address object.
Taggings List<Pulumiverse.Fortios.Firewall.Outputs.GetAddressTagging>: Config object tagging. The structure of tagging block is documented below.
Tenant string: Tenant.
Type string: Type of address.
Uuid string: Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
Visibility string: Enable/disable address visibility in the GUI.
Wildcard string: IP address and wildcard netmask.
WildcardFqdn string: Fully Qualified Domain Name with wildcard characters.
Vdomparam string

AllowRouting string: Enable/disable use of this address in the static route configuration.
AssociatedInterface string: Network interface associated with address.
CacheTtl int: Defines the minimal TTL of individual IP addresses in FQDN cache measured in seconds.
ClearpassSpt string: SPT (System Posture Token) value.
Color int: Color of icon on the GUI.
Comment string: Comment.
Country string: IP addresses associated to a specific country.
EndIp string: Final IP address (inclusive) in the range for the address.
EndMac string: Last MAC address in the range.
EpgName string: Endpoint group name.
FabricObject string: Security Fabric global object setting.
Filter string: Match criteria filter.
Fqdn string: Fully Qualified Domain Name address.
FssoGroups []GetAddressFssoGroup: FSSO group(s). The structure of fsso_group block is documented below.
HwModel string: Dynamic address matching hardware model.
HwVendor string: Dynamic address matching hardware vendor.
Id string: The provider-assigned unique ID for this managed resource.
Interface string: Name of interface whose IP address is to be used.
Lists []GetAddressList: IP address list. The structure of list block is documented below.
Macaddrs []GetAddressMacaddr: MAC address ranges [-] separated by space.
Name string: Tag name.
NodeIpOnly string: Enable/disable collection of node addresses only in Kubernetes.
ObjId string: Object ID for NSX.
ObjTag string: Tag of dynamic address object.
ObjType string: Object type.
Organization string: Organization domain name (Syntax: organization/domain).
Os string: Dynamic address matching operating system.
PolicyGroup string: Policy group name.
RouteTag int: route-tag address.
Sdn string: SDN.
SdnAddrType string: Type of addresses to collect.
SdnTag string: SDN Tag.
StartIp string: First IP address (inclusive) in the range for the address.
StartMac string: First MAC address in the range.
SubType string: Sub-type of address.
Subnet string: IP address and subnet mask of address.
SubnetName string: Subnet name.
SwVersion string: Dynamic address matching software version.
TagDetectionLevel string: Tag detection level of dynamic address object.
TagType string: Tag type of dynamic address object.
Taggings []GetAddressTagging: Config object tagging. The structure of tagging block is documented below.
Tenant string: Tenant.
Type string: Type of address.
Uuid string: Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
Visibility string: Enable/disable address visibility in the GUI.
Wildcard string: IP address and wildcard netmask.
WildcardFqdn string: Fully Qualified Domain Name with wildcard characters.
Vdomparam string

allowRouting String: Enable/disable use of this address in the static route configuration.
associatedInterface String: Network interface associated with address.
cacheTtl Integer: Defines the minimal TTL of individual IP addresses in FQDN cache measured in seconds.
clearpassSpt String: SPT (System Posture Token) value.
color Integer: Color of icon on the GUI.
comment String: Comment.
country String: IP addresses associated to a specific country.
endIp String: Final IP address (inclusive) in the range for the address.
endMac String: Last MAC address in the range.
epgName String: Endpoint group name.
fabricObject String: Security Fabric global object setting.
filter String: Match criteria filter.
fqdn String: Fully Qualified Domain Name address.
fssoGroups List<GetAddressFssoGroup>: FSSO group(s). The structure of fsso_group block is documented below.
hwModel String: Dynamic address matching hardware model.
hwVendor String: Dynamic address matching hardware vendor.
id String: The provider-assigned unique ID for this managed resource.
interface_ String: Name of interface whose IP address is to be used.
lists List<GetAddressList>: IP address list. The structure of list block is documented below.
macaddrs List<GetAddressMacaddr>: MAC address ranges [-] separated by space.
name String: Tag name.
nodeIpOnly String: Enable/disable collection of node addresses only in Kubernetes.
objId String: Object ID for NSX.
objTag String: Tag of dynamic address object.
objType String: Object type.
organization String: Organization domain name (Syntax: organization/domain).
os String: Dynamic address matching operating system.
policyGroup String: Policy group name.
routeTag Integer: route-tag address.
sdn String: SDN.
sdnAddrType String: Type of addresses to collect.
sdnTag String: SDN Tag.
startIp String: First IP address (inclusive) in the range for the address.
startMac String: First MAC address in the range.
subType String: Sub-type of address.
subnet String: IP address and subnet mask of address.
subnetName String: Subnet name.
swVersion String: Dynamic address matching software version.
tagDetectionLevel String: Tag detection level of dynamic address object.
tagType String: Tag type of dynamic address object.
taggings List<GetAddressTagging>: Config object tagging. The structure of tagging block is documented below.
tenant String: Tenant.
type String: Type of address.
uuid String: Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
visibility String: Enable/disable address visibility in the GUI.
wildcard String: IP address and wildcard netmask.
wildcardFqdn String: Fully Qualified Domain Name with wildcard characters.
vdomparam String

allowRouting string: Enable/disable use of this address in the static route configuration.
associatedInterface string: Network interface associated with address.
cacheTtl number: Defines the minimal TTL of individual IP addresses in FQDN cache measured in seconds.
clearpassSpt string: SPT (System Posture Token) value.
color number: Color of icon on the GUI.
comment string: Comment.
country string: IP addresses associated to a specific country.
endIp string: Final IP address (inclusive) in the range for the address.
endMac string: Last MAC address in the range.
epgName string: Endpoint group name.
fabricObject string: Security Fabric global object setting.
filter string: Match criteria filter.
fqdn string: Fully Qualified Domain Name address.
fssoGroups GetAddressFssoGroup[]: FSSO group(s). The structure of fsso_group block is documented below.
hwModel string: Dynamic address matching hardware model.
hwVendor string: Dynamic address matching hardware vendor.
id string: The provider-assigned unique ID for this managed resource.
interface string: Name of interface whose IP address is to be used.
lists GetAddressList[]: IP address list. The structure of list block is documented below.
macaddrs GetAddressMacaddr[]: MAC address ranges [-] separated by space.
name string: Tag name.
nodeIpOnly string: Enable/disable collection of node addresses only in Kubernetes.
objId string: Object ID for NSX.
objTag string: Tag of dynamic address object.
objType string: Object type.
organization string: Organization domain name (Syntax: organization/domain).
os string: Dynamic address matching operating system.
policyGroup string: Policy group name.
routeTag number: route-tag address.
sdn string: SDN.
sdnAddrType string: Type of addresses to collect.
sdnTag string: SDN Tag.
startIp string: First IP address (inclusive) in the range for the address.
startMac string: First MAC address in the range.
subType string: Sub-type of address.
subnet string: IP address and subnet mask of address.
subnetName string: Subnet name.
swVersion string: Dynamic address matching software version.
tagDetectionLevel string: Tag detection level of dynamic address object.
tagType string: Tag type of dynamic address object.
taggings GetAddressTagging[]: Config object tagging. The structure of tagging block is documented below.
tenant string: Tenant.
type string: Type of address.
uuid string: Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
visibility string: Enable/disable address visibility in the GUI.
wildcard string: IP address and wildcard netmask.
wildcardFqdn string: Fully Qualified Domain Name with wildcard characters.
vdomparam string

allow_routing str: Enable/disable use of this address in the static route configuration.
associated_interface str: Network interface associated with address.
cache_ttl int: Defines the minimal TTL of individual IP addresses in FQDN cache measured in seconds.
clearpass_spt str: SPT (System Posture Token) value.
color int: Color of icon on the GUI.
comment str: Comment.
country str: IP addresses associated to a specific country.
end_ip str: Final IP address (inclusive) in the range for the address.
end_mac str: Last MAC address in the range.
epg_name str: Endpoint group name.
fabric_object str: Security Fabric global object setting.
filter str: Match criteria filter.
fqdn str: Fully Qualified Domain Name address.
fsso_groups Sequence[GetAddressFssoGroup]: FSSO group(s). The structure of fsso_group block is documented below.
hw_model str: Dynamic address matching hardware model.
hw_vendor str: Dynamic address matching hardware vendor.
id str: The provider-assigned unique ID for this managed resource.
interface str: Name of interface whose IP address is to be used.
lists Sequence[GetAddressList]: IP address list. The structure of list block is documented below.
macaddrs Sequence[GetAddressMacaddr]: MAC address ranges [-] separated by space.
name str: Tag name.
node_ip_only str: Enable/disable collection of node addresses only in Kubernetes.
obj_id str: Object ID for NSX.
obj_tag str: Tag of dynamic address object.
obj_type str: Object type.
organization str: Organization domain name (Syntax: organization/domain).
os str: Dynamic address matching operating system.
policy_group str: Policy group name.
route_tag int: route-tag address.
sdn str: SDN.
sdn_addr_type str: Type of addresses to collect.
sdn_tag str: SDN Tag.
start_ip str: First IP address (inclusive) in the range for the address.
start_mac str: First MAC address in the range.
sub_type str: Sub-type of address.
subnet str: IP address and subnet mask of address.
subnet_name str: Subnet name.
sw_version str: Dynamic address matching software version.
tag_detection_level str: Tag detection level of dynamic address object.
tag_type str: Tag type of dynamic address object.
taggings Sequence[GetAddressTagging]: Config object tagging. The structure of tagging block is documented below.
tenant str: Tenant.
type str: Type of address.
uuid str: Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
visibility str: Enable/disable address visibility in the GUI.
wildcard str: IP address and wildcard netmask.
wildcard_fqdn str: Fully Qualified Domain Name with wildcard characters.
vdomparam str

allowRouting String: Enable/disable use of this address in the static route configuration.
associatedInterface String: Network interface associated with address.
cacheTtl Number: Defines the minimal TTL of individual IP addresses in FQDN cache measured in seconds.
clearpassSpt String: SPT (System Posture Token) value.
color Number: Color of icon on the GUI.
comment String: Comment.
country String: IP addresses associated to a specific country.
endIp String: Final IP address (inclusive) in the range for the address.
endMac String: Last MAC address in the range.
epgName String: Endpoint group name.
fabricObject String: Security Fabric global object setting.
filter String: Match criteria filter.
fqdn String: Fully Qualified Domain Name address.
fssoGroups List<Property Map>: FSSO group(s). The structure of fsso_group block is documented below.
hwModel String: Dynamic address matching hardware model.
hwVendor String: Dynamic address matching hardware vendor.
id String: The provider-assigned unique ID for this managed resource.
interface String: Name of interface whose IP address is to be used.
lists List<Property Map>: IP address list. The structure of list block is documented below.
macaddrs List<Property Map>: MAC address ranges [-] separated by space.
name String: Tag name.
nodeIpOnly String: Enable/disable collection of node addresses only in Kubernetes.
objId String: Object ID for NSX.
objTag String: Tag of dynamic address object.
objType String: Object type.
organization String: Organization domain name (Syntax: organization/domain).
os String: Dynamic address matching operating system.
policyGroup String: Policy group name.
routeTag Number: route-tag address.
sdn String: SDN.
sdnAddrType String: Type of addresses to collect.
sdnTag String: SDN Tag.
startIp String: First IP address (inclusive) in the range for the address.
startMac String: First MAC address in the range.
subType String: Sub-type of address.
subnet String: IP address and subnet mask of address.
subnetName String: Subnet name.
swVersion String: Dynamic address matching software version.
tagDetectionLevel String: Tag detection level of dynamic address object.
tagType String: Tag type of dynamic address object.
taggings List<Property Map>: Config object tagging. The structure of tagging block is documented below.
tenant String: Tenant.
type String: Type of address.
uuid String: Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
visibility String: Enable/disable address visibility in the GUI.
wildcard String: IP address and wildcard netmask.
wildcardFqdn String: Fully Qualified Domain Name with wildcard characters.
vdomparam String

Supporting Types

GetAddressFssoGroup

Name string: Specify the name of the desired firewall address.

Name string: Specify the name of the desired firewall address.

name String: Specify the name of the desired firewall address.

name string: Specify the name of the desired firewall address.

name str: Specify the name of the desired firewall address.

name String: Specify the name of the desired firewall address.

GetAddressList

Ip string: IP.

Ip string: IP.

ip String: IP.

ip string: IP.

ip str: IP.

ip String: IP.

GetAddressMacaddr

Macaddr string: MAC address ranges [-] separated by space.

Macaddr string: MAC address ranges [-] separated by space.

macaddr String: MAC address ranges [-] separated by space.

macaddr string: MAC address ranges [-] separated by space.

macaddr str: MAC address ranges [-] separated by space.

macaddr String: MAC address ranges [-] separated by space.

GetAddressTagging

Category string: Tag category.
Name string: Specify the name of the desired firewall address.
Tags List<Pulumiverse.Fortios.Firewall.Inputs.GetAddressTaggingTag>: Tags. The structure of tags block is documented below.

Category string: Tag category.
Name string: Specify the name of the desired firewall address.
Tags []GetAddressTaggingTag: Tags. The structure of tags block is documented below.

category String: Tag category.
name String: Specify the name of the desired firewall address.
tags List<GetAddressTaggingTag>: Tags. The structure of tags block is documented below.

category string: Tag category.
name string: Specify the name of the desired firewall address.
tags GetAddressTaggingTag[]: Tags. The structure of tags block is documented below.

category str: Tag category.
name str: Specify the name of the desired firewall address.
tags Sequence[GetAddressTaggingTag]: Tags. The structure of tags block is documented below.

category String: Tag category.
name String: Specify the name of the desired firewall address.
tags List<Property Map>: Tags. The structure of tags block is documented below.

GetAddressTaggingTag

Name string: Specify the name of the desired firewall address.

Name string: Specify the name of the desired firewall address.

name String: Specify the name of the desired firewall address.

name string: Specify the name of the desired firewall address.

name str: Specify the name of the desired firewall address.

name String: Specify the name of the desired firewall address.

Package Details

Repository: fortios pulumiverse/pulumi-fortios
License: Apache-2.0
Notes: This Pulumi package is based on the fortios Terraform Provider.

Fortios v0.0.5 published on Tuesday, Apr 9, 2024 by pulumiverse

pulumiverse/pulumi-fortios

fortios.firewall.getAddress

On this page

On this page

Using getAddress

getAddress Result

Supporting Types

GetAddressFssoGroup

GetAddressList

GetAddressMacaddr

GetAddressTagging

GetAddressTaggingTag

Package Details

On this page

On this page