Management API Reference for address-resolver-option

Configuration options for Vert.x hostname resolver.

Provided Capabilities (1)

Name	Dynamic	Other provider points
org.wildfly.extension.vertx.options.address.resolver	true	none

Attributes (14)

cache-max-time-to-live - The cache maximum TTL value in seconds. After successful resolution IP addresses are cached with their DNS response TTL,

Type	INT
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The cache maximum TTL value in seconds. After successful resolution IP addresses are cached with their DNS response TTL,", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

cache-min-time-to-live - The cache minimum TTL value in seconds. After successful resolution IP addresses are cached with their DNS response TTL,

Type	INT
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The cache minimum TTL value in seconds. After successful resolution IP addresses are cached with their DNS response TTL,", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

cache-negative-time-to-live - The negative cache TTL value in seconds. After a failed hostname resolution, DNS queries won't be retried for a period of time equals to the negative TTL.

Type	INT
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The negative cache TTL value in seconds. After a failed hostname resolution, DNS queries won't be retried for a period of time equals to the negative TTL.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

hosts-refresh-period - The hosts configuration refresh period in millis

Type	INT
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The hosts configuration refresh period in millis", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

hosts-value - The alternate hosts configuration file to use instead of the one provided by the os.

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The alternate hosts configuration file to use instead of the one provided by the os.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

max-queries - The maximum number of queries when an hostname is resolved.

Type	INT
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The maximum number of queries when an hostname is resolved.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

n-dots - The ndots value used when resolving using search domains, the default value is -1 which determines the value from the OS on Linux or uses the value 1.

Type	INT
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The ndots value used when resolving using search domains, the default value is -1 which determines the value from the OS on Linux or uses the value 1.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

opt-resource-enabled - The option to enable the automatic inclusion in DNS queries of an optional record that hints the remote DNS server about how much data the resolver can read per response.

Type	BOOLEAN
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "The option to enable the automatic inclusion in DNS queries of an optional record that hints the remote DNS server about how much data the resolver can read per response.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

query-time-out - The query timeout in milliseconds, i.e the amount of time after a query is considered to be failed.

Type	LONG
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "LONG" }, "description" : "The query timeout in milliseconds, i.e the amount of time after a query is considered to be failed.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

rd-flag - The DNS queries Recursion Desired flag value, defaults is true.

Type	BOOLEAN
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "The DNS queries Recursion Desired flag value, defaults is true.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

rotate-servers - The option to enable round-robin selection of the dns server to use. It spreads the query load among the servers and avoids all lookup to hit the first server of the list.

Type	BOOLEAN
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "The option to enable round-robin selection of the dns server to use. It spreads the query load among the servers and avoids all lookup to hit the first server of the list.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

round-robin-inet-address - The option to enable round-robin inet address selection of the ip address to use.

Type	BOOLEAN
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "The option to enable round-robin inet address selection of the ip address to use.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

search-domains - The lists of DNS search domains. When the search domain list is null, the effective search domain list will be populated using the system DNS search domains.

Type	LIST
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "The lists of DNS search domains. When the search domain list is null, the effective search domain list will be populated using the system DNS search domains.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 0, "max-length" : 2147483647, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }

servers - The list of DNS server addresses, an address is the IP of the dns server, followed by an optional colon and a port.

Type	LIST
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "The list of DNS server addresses, an address is the IP of the dns server, followed by an optional colon and a port.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 0, "max-length" : 2147483647, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

Operations (2)

🅿 add - Add the AddressResolverOptions

Request Parameter	Type	Required	Expressions Allowed	Description
cache-max-time-to-live	INT	false	true	The cache maximum TTL value in seconds. After successful resolution IP addresses are cached with their DNS response TTL,
cache-min-time-to-live	INT	false	true	The cache minimum TTL value in seconds. After successful resolution IP addresses are cached with their DNS response TTL,
cache-negative-time-to-live	INT	false	true	The negative cache TTL value in seconds. After a failed hostname resolution, DNS queries won't be retried for a period of time equals to the negative TTL.
hosts-refresh-period	INT	false	true	The hosts configuration refresh period in millis
hosts-value	STRING	false	true	The alternate hosts configuration file to use instead of the one provided by the os.
max-queries	INT	false	true	The maximum number of queries when an hostname is resolved.
n-dots	INT	false	true	The ndots value used when resolving using search domains, the default value is -1 which determines the value from the OS on Linux or uses the value 1.
opt-resource-enabled	BOOLEAN	false	true	The option to enable the automatic inclusion in DNS queries of an optional record that hints the remote DNS server about how much data the resolver can read per response.
query-time-out	LONG	false	true	The query timeout in milliseconds, i.e the amount of time after a query is considered to be failed.
rd-flag	BOOLEAN	false	true	The DNS queries Recursion Desired flag value, defaults is true.
rotate-servers	BOOLEAN	false	true	The option to enable round-robin selection of the dns server to use. It spreads the query load among the servers and avoids all lookup to hit the first server of the list.
round-robin-inet-address	BOOLEAN	false	true	The option to enable round-robin inet address selection of the ip address to use.
search-domains	LIST	false	true	The lists of DNS search domains. When the search domain list is null, the effective search domain list will be populated using the system DNS search domains.
servers	LIST	false	true	The list of DNS server addresses, an address is the IP of the dns server, followed by an optional colon and a port.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Add the AddressResolverOptions",
    "request-properties" : {
        "cache-max-time-to-live" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "The cache maximum TTL value in seconds. After successful resolution IP addresses are cached with their DNS response TTL,",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default"
        },
        "cache-min-time-to-live" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "The cache minimum TTL value in seconds. After successful resolution IP addresses are cached with their DNS response TTL,",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default"
        },
        "cache-negative-time-to-live" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "The negative cache TTL value in seconds. After a failed hostname resolution, DNS queries won't be retried for a period of time equals to the negative TTL.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default"
        },
        "hosts-refresh-period" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "The hosts configuration refresh period in millis",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default"
        },
        "hosts-value" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The alternate hosts configuration file to use instead of the one provided by the os.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "max-queries" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "The maximum number of queries when an hostname is resolved.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default"
        },
        "n-dots" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "The ndots value used when resolving using search domains, the default value is -1 which determines the value from the OS on Linux or uses the value 1.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default"
        },
        "opt-resource-enabled" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "The option to enable the automatic inclusion in DNS queries of an optional record that hints the remote DNS server about how much data the resolver can read per response.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default"
        },
        "query-time-out" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LONG"
            },
            "description" : "The query timeout in milliseconds, i.e the amount of time after a query is considered to be failed.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default"
        },
        "rd-flag" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "The DNS queries Recursion Desired flag value, defaults is true.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default"
        },
        "rotate-servers" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "The option to enable round-robin selection of the dns server to use. It spreads the query load among the servers and avoids all lookup to hit the first server of the list.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default"
        },
        "round-robin-inet-address" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "The option to enable round-robin inet address selection of the ip address to use.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default"
        },
        "search-domains" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LIST"
            },
            "description" : "The lists of DNS search domains. When the search domain list is null, the effective search domain list will be populated using the system DNS search domains.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 0,
            "max-length" : 2147483647,
            "stability" : "default",
            "value-type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            }
        },
        "servers" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LIST"
            },
            "description" : "The list of DNS server addresses, an address is the IP  of the dns server, followed by an optional colon and a port.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 0,
            "max-length" : 2147483647,
            "stability" : "default",
            "value-type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            }
        }
    },
    "reply-properties" : {},
    "stability" : "preview",
    "read-only" : false,
    "runtime-only" : false
}

remove - Remove the AddressResolverOptions

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Remove the AddressResolverOptions",
    "request-properties" : {},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "restart-required" : "all-services",
    "runtime-only" : false
}

Galleon Features

Galleon features are to be used when creating Galleon feature-packs.

subsystem.vertx.address-resolver-option

        
<feature spec="subsystem.vertx.address-resolver-option">
  <param name="address-resolver-option" value="{resource name}"/>
  <param name="cache-max-time-to-live" value="{value}"/>
  <param name="cache-min-time-to-live" value="{value}"/>
  <param name="cache-negative-time-to-live" value="{value}"/>
  <param name="hosts-refresh-period" value="{value}"/>
  <param name="hosts-value" value="{value}"/>
  <param name="max-queries" value="{value}"/>
  <param name="n-dots" value="{value}"/>
  <param name="opt-resource-enabled" value="{value}"/>
  <param name="query-time-out" value="{value}"/>
  <param name="rd-flag" value="{value}"/>
  <param name="rotate-servers" value="{value}"/>
  <param name="round-robin-inet-address" value="{value}"/>
  <param name="search-domains" value="{value}"/>
  <param name="servers" value="{value}"/>
<feature/>