guides:reference:infoblox:plugin_infoblox_dns
Differences
This shows you the differences between two versions of the page.
| guides:reference:infoblox:plugin_infoblox_dns [2023/02/09 09:20] – [Add_static_dhcp] pgels | guides:reference:infoblox:plugin_infoblox_dns [2024/07/03 12:31] (current) – external edit 127.0.0.1 | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| + | {{indexmenu_n> | ||
| + | |||
| + | ===== Infoblox DNS API plugin ===== | ||
| + | |||
| + | > <color orange> | ||
| + | |||
| + | |||
| + | Based on the original NetYCE - Infoblox integration module, a new API plugin module has been developed. The new module XML payload differs only in details, bit offers greatly more control over the Infoblox objects being created. | ||
| + | |||
| + | Identified by the new set of requirements and the original hard-coded validations, | ||
| + | |||
| + | The assignment of Infoblox Extensible-attibutes is fully supported. | ||
| + | |||
| + | ==== Integration configuration ==== | ||
| + | |||
| + | The Infoblox integration is setup using the configuration file "**YCE Infoblox integration**" | ||
| + | |||
| + | This configuration file defines: | ||
| + | * GridMaster ip-address | ||
| + | * userid of the Infoblox functional user | ||
| + | * password of the functional user | ||
| + | * the default view name | ||
| + | * the default custom DHCP option space name | ||
| + | * the Vip-addresses of the GridMembers for HK's and BK's | ||
| + | |||
| + | |||
| + | ==== Transaction types ==== | ||
| + | |||
| + | This module supports the following request types: | ||
| + | ^Request^Purpose^ | ||
| + | |Add_host|Create a DNS Host-record or A-record using a fixed ip-address, or finds a free address given a set of IPAM subnets. Optionally creates Host-aliases or Cnames. Ip-address migration is supported using add_host| | ||
| + | |Clear_host|Remove a Host-record or A-record from the DNS. For Host records, a specific ip-address can be removed too. Optionally removes any Cnames where the fqdn is used a the canonical| | ||
| + | |Clear_ip|Removes Host-records, | ||
| + | |Set_host|Update attributes of an existing Host, A-record or Cname. Supported attributes are ' | ||
| + | |Add_alias|Create one or more Host-aliases or Cnames for an existing Host-record or A-record| | ||
| + | |Clear_alias|Remove one or more Host-aliases from a Host-record or Cnames using the canonical fqdn| | ||
| + | |Show_host|Returns the current settings and attributes of an existing Host-record, | ||
| + | |Show_subnet|Returns the current set of settings and attributes of an IPAM subnet, including a list of its addresses and their DNS or DHCP allocation| | ||
| + | |Subnet_report|Returns a full IPAM export of all subnets and their attributes| | ||
| + | |Host_report|Returns a full DNS report, cross-referenced with IPAM subnets and ip-addresses for Host-records, | ||
| + | |Dns_report|Is an alternate name to the ' | ||
| + | |Subnet_report|Returns a full IPAM export of all subnets and their attributes| | ||
| + | |Extattr_report|Returns all Extensible Attributes with their definitions as defined on the Gridmaster| | ||
| + | |Add_static_dhcp|Adds a new static dhcp| | ||
| + | |Clear_static_dhcp|Clears a static dhcp| | ||
| + | |||
| + | |||
| + | ==== Add_host ==== | ||
| + | |||
| + | Add Host or A-record with optional aliases (as Cnames) using predetermined or hunted ip-address | ||
| + | |||
| + | There are several variations of this request. The basic request specifies a new DNS hostname and zone (domain), the record type and a pre-determined address. | ||
| + | |||
| + | <code xml> | ||
| + | <task response=""> | ||
| + | <head | ||
| + | passwd=" | ||
| + | task_name=" | ||
| + | task_type=" | ||
| + | userid=" | ||
| + | /> | ||
| + | <request action_type=" | ||
| + | <host | ||
| + | host_domain=" | ||
| + | host_name=" | ||
| + | record_type=" | ||
| + | comment=" | ||
| + | > | ||
| + | < | ||
| + | </ | ||
| + | </ | ||
| + | </ | ||
| + | </ | ||
| + | |||
| + | An extensive version adds some returned logging, a series of extensible-attributes to be defined for this record, and two aliases to be created too. The type of aliases (host or cname) depends on policy settings. | ||
| + | |||
| + | <code xml> | ||
| + | <task response=""> | ||
| + | <head | ||
| + | passwd=" | ||
| + | task_name=" | ||
| + | task_type=" | ||
| + | userid=" | ||
| + | log_level=" | ||
| + | /> | ||
| + | <request action_type=" | ||
| + | <host | ||
| + | host_domain=" | ||
| + | host_name=" | ||
| + | record_type=" | ||
| + | comment=" | ||
| + | > | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | </ | ||
| + | </ | ||
| + | </ | ||
| + | </ | ||
| + | |||
| + | And as another example, a basic A-record is created where the ip-address will be allocated from the first free address in a set of subnets. | ||
| + | |||
| + | <code xml> | ||
| + | <task response=""> | ||
| + | <head | ||
| + | passwd=" | ||
| + | task_name=" | ||
| + | task_type=" | ||
| + | userid=" | ||
| + | /> | ||
| + | <request action_type=" | ||
| + | <host | ||
| + | host_domain=" | ||
| + | host_name=" | ||
| + | record_type=" | ||
| + | comment=" | ||
| + | > | ||
| + | < | ||
| + | < | ||
| + | </ | ||
| + | </ | ||
| + | </ | ||
| + | </ | ||
| + | |||
| + | == IP-migration == | ||
| + | |||
| + | The Add_host call can be used to migrate the ip-address of an existing Host-record or A-record by setting the optional attribute '' | ||
| + | When set yo " | ||
| + | |||
| + | This example also demonstrates the use of the attributes '' | ||
| + | |||
| + | <code xml> | ||
| + | <task response=""> | ||
| + | <head | ||
| + | passwd=" | ||
| + | task_name=" | ||
| + | task_type=" | ||
| + | userid=" | ||
| + | log_level=" | ||
| + | /> | ||
| + | <request action_type=" | ||
| + | <host | ||
| + | host_domain=" | ||
| + | host_name=" | ||
| + | record_type=" | ||
| + | new_ip_addr=" | ||
| + | comment=" | ||
| + | disable=" | ||
| + | ttl=" | ||
| + | > | ||
| + | < | ||
| + | | ||
| + | /> | ||
| + | < | ||
| + | </ | ||
| + | </ | ||
| + | </ | ||
| + | </ | ||
| + | |||
| + | == Views == | ||
| + | |||
| + | The Infoblox environment uses names to identify IPAM-views and DNS-views. The DNS-views are hierarchically associated with the IPAM-view. The IPAM-view contains the ipv4 and ipv6 subnet definitions that may be used in that view, the DNS-views associated with an IPAM-view contain the DNS domain-names that can be used. | ||
| + | |||
| + | Any Infoblox DNS operation needs to have both views specified and must match their association. For both views defaults are defined in the NetYCE configuration file '' | ||
| + | |||
| + | When not using the default views, they can be specified using the '' | ||
| + | |||
| + | <code xml> | ||
| + | < | ||
| + | <head | ||
| + | passwd=" | ||
| + | task_name=" | ||
| + | task_type=" | ||
| + | userid=" | ||
| + | log_level=" | ||
| + | /> | ||
| + | <request action_type=" | ||
| + | <host | ||
| + | host_domain=" | ||
| + | host_name=" | ||
| + | record_type=" | ||
| + | ipam_view=" | ||
| + | dns_view=" | ||
| + | > | ||
| + | < | ||
| + | < | ||
| + | </ | ||
| + | </ | ||
| + | </ | ||
| + | </ | ||
| + | |||
| + | |||
| + | == Attributes == | ||
| + | |||
| + | ^Attribute name^Object^Values^Description^ | ||
| + | |**log_level**|head|' | ||
| + | |**host_name**|host|host name|The hostname part of the new DNS record fqdn (full qualified domain name). Many policies exist that define the host-name validation.| | ||
| + | |**host_domain**|host|zone name|The domain part of the new record fqdn. Many policies exist that define the domain-name validation.| | ||
| + | |**record_type**|host|' | ||
| + | |**comment**|host|string|The text to be assigned to the " | ||
| + | |**disable**|host|' | ||
| + | |**ttl**|host|' | ||
| + | |**ipv4_addr**|host|ipv4-address with prefix|The fixed ipv4-address for the new DNS record including its subnet prefix. The subnet must exist in the IPAM which network-address is calculated from the ip-address and the prefix. When an '' | ||
| + | |**subnet_addr**|host|network-address with prefix|The first free ip-address is used for the new DNS record. Multiple '' | ||
| + | |**ipv6_addr**|host|ipv6-address with prefix|The fixed ipv6-address for the new DNS record including its subnet prefix. The ipv6-subnet must exist in the IPAM-view which network-address is calculated from the ip-address and the prefix. Only the first '' | ||
| + | |**alias**|host|fqdn|The full qualified domain name of the ' | ||
| + | |**ext_attr**|host|name-value pair|Extensible attributes must be pre-defined in the Infoblox GridMaster. The '' | ||
| + | |**ipam_view**|host|IPAM-view name|specify the Infoblox IPAM-view. The default is configured in ' | ||
| + | |**dns_view**|host|DNS-view name|specify the Infoblox DNS-view. The default is configured in ' | ||
| + | |||
| + | |||
| + | Extensible attributes may be included in the request using two distinct XML formats. In addition to the example above, this format is available too. Note however, that this last form will cause XML parsing errors if duplicate '' | ||
| + | |||
| + | <code xml> | ||
| + | |||
| + | < | ||
| + | rfc=" | ||
| + | srv=" | ||
| + | site=" | ||
| + | ReferenceCode=" | ||
| + | building=" | ||
| + | Netwerkomgeving=" | ||
| + | /> | ||
| + | |||
| + | </ | ||
| + | |||
| + | |||
| + | |||
| + | ==== Clear_host ==== | ||
| + | |||
| + | Remove Host-record or A-record. Optionally remove referring Cnames too. | ||
| + | |||
| + | <code xml> | ||
| + | <task response=""> | ||
| + | <head | ||
| + | passwd=" | ||
| + | task_name=" | ||
| + | task_type=" | ||
| + | userid=" | ||
| + | log_level=" | ||
| + | /> | ||
| + | <request action_type=" | ||
| + | <host | ||
| + | host_domain=" | ||
| + | host_name=" | ||
| + | record_type=" | ||
| + | clear_cnames=" | ||
| + | comment=" | ||
| + | > | ||
| + | </ | ||
| + | </ | ||
| + | </ | ||
| + | </ | ||
| + | |||
| + | == Attributes == | ||
| + | |||
| + | ^Attribute name^Object^Values^Description^ | ||
| + | |**log_level**|head|' | ||
| + | |**host_name**|host|host name|The hostname part of the existing DNS record fqdn (full qualified domain name).| | ||
| + | |**host_domain**|host|zone name|The domain part of the existing record fqdn.| | ||
| + | |**record_type**|host|' | ||
| + | |**comment**|host|string|Attribute will be ignored| | ||
| + | |**clear_cnames**|host|' | ||
| + | |**alias**|host|fqdn|Attribute will be ignored| | ||
| + | |**ext_attr**|host|name-value pair|Extensible attributes will be ignored| | ||
| + | |||
| + | |||
| + | ==== Clear_ip ==== | ||
| + | |||
| + | Removes Host-records, | ||
| + | |||
| + | <code xml> | ||
| + | <task response=""> | ||
| + | <head | ||
| + | passwd=" | ||
| + | task_name=" | ||
| + | task_type=" | ||
| + | userid=" | ||
| + | log_level=" | ||
| + | /> | ||
| + | <request action_type=" | ||
| + | <host | ||
| + | | ||
| + | | ||
| + | > | ||
| + | </ | ||
| + | </ | ||
| + | </ | ||
| + | </ | ||
| + | |||
| + | == Attributes == | ||
| + | |||
| + | ^Attribute name^Object^Values^Description^ | ||
| + | |**log_level**|head|' | ||
| + | |**ipv4addr**|host_address|ip-address|The IPv4 address to remove from DNS Host, A-rec and Cname records. The ip-address should not include the prefix.| | ||
| + | |**view**|DNS view name|Intern|Optional attribute that specifies the DNS view where the ip-address will be searched in. Defaults to ' | ||
| + | |**network_view**|IPAM view name|Default|Optional attribute that specifies the IPAM view where the ip-address will be searched in. Defaults to ' | ||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | ==== Set_host ==== | ||
| + | |||
| + | Update attributes of a Host-record, | ||
| + | |||
| + | The available DNS record attributes are: ' | ||
| + | |||
| + | <code xml> | ||
| + | <task response=""> | ||
| + | <head | ||
| + | passwd=" | ||
| + | task_name=" | ||
| + | task_type=" | ||
| + | userid=" | ||
| + | log_level=" | ||
| + | /> | ||
| + | <request action_type=" | ||
| + | <host | ||
| + | host_domain=" | ||
| + | host_name=" | ||
| + | record_type=" | ||
| + | comment=" | ||
| + | disable=" | ||
| + | ttl=" | ||
| + | > | ||
| + | < | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | /> | ||
| + | </ | ||
| + | </ | ||
| + | </ | ||
| + | </ | ||
| + | |||
| + | == Attributes == | ||
| + | |||
| + | ^Attribute name^Object^Values^Description^ | ||
| + | |**log_level**|head|' | ||
| + | |**host_name**|host|host name|The hostname part of the existing DNS record fqdn (full qualified domain name).| | ||
| + | |**host_domain**|host|zone name|The domain part of the existing record fqdn.| | ||
| + | |**record_type**|host|' | ||
| + | |**comment**|host|string|The text to be assigned to the " | ||
| + | |**disable**|host|' | ||
| + | |**ttl**|host|' | ||
| + | |**ext_attr**|host|name-value pair|Extensible attributes must be pre-defined in the Infoblox GridMaster. The '' | ||
| + | |||
| + | ==== Add_alias ==== | ||
| + | |||
| + | Create multiple Cnames or Host-aliases for an existing canonical (an existing A-record or Host-record) | ||
| + | |||
| + | <code xml> | ||
| + | <task response=""> | ||
| + | <head | ||
| + | passwd=" | ||
| + | task_name=" | ||
| + | task_type=" | ||
| + | userid=" | ||
| + | log_level=" | ||
| + | /> | ||
| + | <request action_type=" | ||
| + | <host | ||
| + | host_domain=" | ||
| + | host_name=" | ||
| + | record_type=" | ||
| + | comment=" | ||
| + | > | ||
| + | < | ||
| + | rfc=" | ||
| + | srv=" | ||
| + | site=" | ||
| + | ReferenceCode=" | ||
| + | building=" | ||
| + | Netwerkomgeving=" | ||
| + | /> | ||
| + | < | ||
| + | < | ||
| + | </ | ||
| + | </ | ||
| + | </ | ||
| + | </ | ||
| + | |||
| + | == Attributes == | ||
| + | |||
| + | ^Attribute name^Object^Values^Description^ | ||
| + | |**log_level**|head|' | ||
| + | |**host_name**|host|host name|The hostname part of the existing DNS record fqdn (full qualified domain name).| | ||
| + | |**host_domain**|host|zone name|The domain part of the existing record fqdn.| | ||
| + | |**record_type**|host|' | ||
| + | |**comment**|host|string|The text to be assigned to the “comment” of the new record. If the string length allows, a timestamp in brackets will be appended| | ||
| + | |**disable**|host|' | ||
| + | |**ttl**|host|' | ||
| + | |**alias**|host|fqdn|The full qualified domain name of the ' | ||
| + | |**ext_attr**|host|name-value pair|Extensible attributes must be pre-defined in the Infoblox GridMaster. The name must match an existing extensible-attribute (and applicable to the the record-type) or will be ignored. The value will be validated against its definition. When value fails to match a listed value, the request will be rejected. Attribute name and value validations will be case-insensitive (and corrected). When an existing-attribute is marked as required but is missing, the request is rejected.| | ||
| + | |||
| + | |||
| + | |||
| + | ==== Clear_alias ==== | ||
| + | |||
| + | Remove Cnames or Host-aliases from an existing canonical reference record. | ||
| + | |||
| + | <code xml> | ||
| + | <task response=""> | ||
| + | <head | ||
| + | passwd=" | ||
| + | task_name=" | ||
| + | task_type=" | ||
| + | userid=" | ||
| + | log_level=" | ||
| + | /> | ||
| + | <request action_type=" | ||
| + | <host | ||
| + | host_domain=" | ||
| + | host_name=" | ||
| + | record_type=" | ||
| + | dns_view=" | ||
| + | > | ||
| + | < | ||
| + | < | ||
| + | </ | ||
| + | </ | ||
| + | </ | ||
| + | </ | ||
| + | |||
| + | |||
| + | The < | ||
| + | |||
| + | Multiple C-names/ | ||
| + | |||
| + | Attempting to remove an " | ||
| + | |||
| + | For ' | ||
| + | |||
| + | When clearing a cname record and the host-fqdn is present in the request, the canonical must exist and match the cname. Attempting to remove a host-alias or a cname that is not referring to the canonical (host) will have no effect. | ||
| + | |||
| + | Including < | ||
| + | However, for process tracking, its use could be desirable | ||
| + | |||
| + | ^Attribute name^Object^Values^Description^ | ||
| + | |**log_level**|head|' | ||
| + | |**host_name**|host|host name|The hostname part of the existing DNS record fqdn (full qualified domain name).| | ||
| + | |**host_domain**|host|zone name|The domain part of the existing record fqdn.| | ||
| + | |**host_fqdn**|host|host+zone name|The fqdn of the existing record.| | ||
| + | |**dns_view**|host|DNS view name|The infoblox DNS view name. Default is defined in etc/< | ||
| + | |**record_type**|host|' | ||
| + | |**alias**|host|fqdn|The full qualified domain name of the ' | ||
| + | |||
| + | ==== Show_host ==== | ||
| + | |||
| + | Returns the various attributes for the record requested. The '' | ||
| + | |||
| + | The response includes a list of Cnames (if any) that have a canonical matching the requested record. In case of a Cname record, these are indirect references. | ||
| + | |||
| + | <code xml> | ||
| + | <task response=""> | ||
| + | <head | ||
| + | passwd=" | ||
| + | task_name=" | ||
| + | task_type=" | ||
| + | userid=" | ||
| + | log_level=" | ||
| + | /> | ||
| + | <request action_type=" | ||
| + | <host | ||
| + | host_domain=" | ||
| + | host_name=" | ||
| + | record_type=" | ||
| + | > | ||
| + | </ | ||
| + | </ | ||
| + | </ | ||
| + | </ | ||
| + | |||
| + | ^Attribute name^Object^Values^Description^ | ||
| + | |**host_name**|host|host name|The hostname part of the existing DNS record fqdn (full qualified domain name).| | ||
| + | |**host_domain**|host|zone name|The domain part of the existing record fqdn.| | ||
| + | |**record_type**|host|' | ||
| + | |||
| + | ==== Show_subnet ==== | ||
| + | |||
| + | Reports on attributes of an IPAM subnet and its addresses. For each ip-address the name (associated fqdn) and its use (dns or dhcp) is given. Infoblox cannot report these details for more than 2000 ip-addresses. | ||
| + | |||
| + | The Subnet must exist in the IPAM with the matching prefix or the request will be rejected. | ||
| + | |||
| + | <code xml> | ||
| + | <task response=""> | ||
| + | <head | ||
| + | passwd=" | ||
| + | task_name=" | ||
| + | task_type=" | ||
| + | userid=" | ||
| + | log_level=" | ||
| + | /> | ||
| + | <request action_type=" | ||
| + | <subnet | ||
| + | net_address=" | ||
| + | net_prefix=" | ||
| + | > | ||
| + | </ | ||
| + | </ | ||
| + | </ | ||
| + | </ | ||
| + | |||
| + | ==== Subnet_report ==== | ||
| + | |||
| + | The Infoblox subnet report delivers an XML report on all active subnets defined in the Infoblox IPAM. | ||
| + | |||
| + | <code xml> | ||
| + | <task response=""> | ||
| + | < | ||
| + | passwd=" | ||
| + | task_name=" | ||
| + | task_type=" | ||
| + | userid=" | ||
| + | /> | ||
| + | < | ||
| + | | ||
| + | | ||
| + | /> | ||
| + | </ | ||
| + | </ | ||
| + | |||
| + | The report uses information retrieved by a separate process that continuously extracts IPAM, Zone and DNS data from the Infoblox GridMaster at a gentle pace. This setup allows for instant reporting at moderately aged data (a few hours). | ||
| + | |||
| + | The subnets records reported include any Infoblox ‘Extensible Attributes’ that are defined for that subnet. | ||
| + | |||
| + | Sample response (a very small section): | ||
| + | |||
| + | <code xml> | ||
| + | < | ||
| + | < | ||
| + | error=" | ||
| + | passwd=" | ||
| + | status=" | ||
| + | task_name=" | ||
| + | task_type=" | ||
| + | userid=" | ||
| + | /> | ||
| + | < | ||
| + | action_type=" | ||
| + | auth_agent=" | ||
| + | request_id=" | ||
| + | task_module=" | ||
| + | task_sub=" | ||
| + | user_level=" | ||
| + | /> | ||
| + | < | ||
| + | gridmaster=" | ||
| + | > | ||
| + | < | ||
| + | name=" | ||
| + | comment=" | ||
| + | disable=" | ||
| + | net_end=" | ||
| + | net_range=" | ||
| + | net_start=" | ||
| + | netmask=" | ||
| + | network=" | ||
| + | network_container=" | ||
| + | network_view=" | ||
| + | prefix=" | ||
| + | subnet=" | ||
| + | > | ||
| + | < | ||
| + | < | ||
| + | </ | ||
| + | < | ||
| + | name=" | ||
| + | comment=" | ||
| + | disable=" | ||
| + | net_end=" | ||
| + | net_range=" | ||
| + | net_start=" | ||
| + | netmask=" | ||
| + | network=" | ||
| + | network_container=" | ||
| + | network_view=" | ||
| + | prefix=" | ||
| + | subnet=" | ||
| + | /> | ||
| + | ::: | ||
| + | < | ||
| + | name=" | ||
| + | comment=" | ||
| + | disable=" | ||
| + | net_end=" | ||
| + | net_range=" | ||
| + | net_start=" | ||
| + | netmask=" | ||
| + | network=" | ||
| + | network_container=" | ||
| + | network_view=" | ||
| + | prefix=" | ||
| + | subnet=" | ||
| + | > | ||
| + | <options name=" | ||
| + | <options name=" | ||
| + | </ | ||
| + | < | ||
| + | current=" | ||
| + | hosts=" | ||
| + | subnets=" | ||
| + | zones=" | ||
| + | /> | ||
| + | </ | ||
| + | </ | ||
| + | </ | ||
| + | |||
| + | |||
| + | ==== Host_report ==== | ||
| + | |||
| + | The Infoblox host report delivers an XML report on all DNS registrations of all zones. Separate records are created for Hosts, Aliases, A-records and C-names. For each of these records the ip-address is resolved to its corresponding ip-address and IPAM subnet (when available). | ||
| + | |||
| + | <code xml> | ||
| + | <task response=""> | ||
| + | < | ||
| + | passwd=" | ||
| + | task_name=" | ||
| + | task_type=" | ||
| + | userid=" | ||
| + | /> | ||
| + | < | ||
| + | | ||
| + | | ||
| + | /> | ||
| + | </ | ||
| + | </ | ||
| + | |||
| + | The report uses information retrieved by a separate process that continuously extracts IPAM, zone and DNS data from the Infoblox GridMaster at a gentle pace. This setup allows for instant reporting at moderately aged data (a few hours). | ||
| + | |||
| + | The host records reported include any Infoblox ‘Extensible Attributes’ that are defined for that record. | ||
| + | |||
| + | Sample report (section): | ||
| + | |||
| + | <code xml> | ||
| + | < | ||
| + | < | ||
| + | error=" | ||
| + | passwd=" | ||
| + | req_app=" | ||
| + | req_host=" | ||
| + | status=" | ||
| + | task_name=" | ||
| + | task_type=" | ||
| + | /> | ||
| + | < | ||
| + | action_type=" | ||
| + | auth_agent=" | ||
| + | request_id=" | ||
| + | task_module=" | ||
| + | task_sub=" | ||
| + | user_level=" | ||
| + | /> | ||
| + | < | ||
| + | < | ||
| + | name=" | ||
| + | comment=" | ||
| + | ipv4addr=" | ||
| + | subnet=" | ||
| + | type=" | ||
| + | zone=" | ||
| + | > | ||
| + | < | ||
| + | < | ||
| + | </ | ||
| + | < | ||
| + | name=" | ||
| + | comment=" | ||
| + | ipv4addr=" | ||
| + | subnet=" | ||
| + | type=" | ||
| + | zone=" | ||
| + | /> | ||
| + | ::: | ||
| + | < | ||
| + | name=" | ||
| + | comment="" | ||
| + | ipv4addr=" | ||
| + | subnet=" | ||
| + | type=" | ||
| + | zone=" | ||
| + | /> | ||
| + | < | ||
| + | current=" | ||
| + | hosts=" | ||
| + | subnets=" | ||
| + | zones=" | ||
| + | /> | ||
| + | </ | ||
| + | </ | ||
| + | </ | ||
| + | |||
| + | |||
| + | ==== ExtAttr_report ==== | ||
| + | |||
| + | >> <color orange> | ||
| + | |||
| + | Report all Extensible Attributes and their definitions as defined in the GridMaster. | ||
| + | |||
| + | The report is primarily intended to retrieve the list of value items that the Attribute will allow and integrate it in a custom-built user-interface where an appropriate value can be selected. | ||
| + | |||
| + | <code xml> | ||
| + | <task response=""> | ||
| + | < | ||
| + | passwd=" | ||
| + | task_name=" | ||
| + | task_type=" | ||
| + | userid=" | ||
| + | /> | ||
| + | < | ||
| + | | ||
| + | /> | ||
| + | </ | ||
| + | </ | ||
| + | |||
| + | |||
| + | ==== Add_static_dhcp ==== | ||
| + | |||
| + | Adds a new static dhcp address | ||
| + | |||
| + | <code xml> | ||
| + | <task response=""> | ||
| + | <head | ||
| + | passwd=" | ||
| + | task_name=" | ||
| + | task_type=" | ||
| + | userid=" | ||
| + | log_level=" | ||
| + | /> | ||
| + | < | ||
| + | action_type=" | ||
| + | ipv4addr=" | ||
| + | mac=" | ||
| + | /> | ||
| + | </ | ||
| + | </ | ||
| + | </ | ||
| + | |||
| + | == Attributes == | ||
| + | |||
| + | ^Attribute name^Values^Mandatory^Description^ | ||
| + | |**ipv4addr**|ip-address|no|The IPv4 address of the static dhcp address to add| | ||
| + | |**mac**|mac-address|no|the MAC address value of the DHCP Fixed Address| | ||
| + | |||
| + | ==== Clear_static_dhcp ==== | ||
| + | |||
| + | Clears a static dhcp address | ||
| + | |||
| + | <code xml> | ||
| + | <task response=""> | ||
| + | <head | ||
| + | passwd=" | ||
| + | task_name=" | ||
| + | task_type=" | ||
| + | userid=" | ||
| + | log_level=" | ||
| + | /> | ||
| + | < | ||
| + | action_type=" | ||
| + | ipv4addr=" | ||
| + | mac=" | ||
| + | /> | ||
| + | </ | ||
| + | </ | ||
| + | </ | ||
| + | |||
| + | == Attributes == | ||
| + | |||
| + | ^Attribute name^Values^Mandatory^Description^ | ||
| + | |**log_level**|' | ||
| + | |**mac**|mac-address|no|the MAC address value of the DHCP Fixed Address| | ||
| + | |**network_view**|' | ||
| + | |||
| + | |||
| + | |||
| + | ==== Policies ==== | ||
| + | |||
| + | The module has a section that defines the many policies that can be customized to alter the validation and behaviour of the module. | ||
| + | |||
| + | <code perl> | ||
| + | default_host_type => ' | ||
| + | default_alias_type => ' | ||
| + | default_clear_cnames => ' | ||
| + | unique_addresses => ' | ||
| + | unique_fqdn => ' | ||
| + | reject_host_alias => ' | ||
| + | fqdn_max_length => ' | ||
| + | comment_max_length => ' | ||
| + | hostname_min_length => ' | ||
| + | hostname_underscore => ' | ||
| + | hostname_dotted_hosts => ' | ||
| + | hostname_special_chars => ' | ||
| + | hostname_start_letter => ' | ||
| + | hostname_trailing_dash => ' | ||
| + | domain_min_length => ' | ||
| + | domain_underscore => ' | ||
| + | domain_special_chars => ' | ||
| + | domain_start_letter => ' | ||
| + | domain_dotted => ' | ||
| + | domain_trailing_dash => ' | ||
| + | domain_must_exist => ' | ||
| + | subnet_must_exist => ' | ||
| + | free_addr_skip => { | ||
| + | 26 => 10, # /26 skips first 10 addr | ||
| + | 27 => 5, # /27 skips first 5 addr | ||
| + | 28 => 5, # you got it | ||
| + | 29 => 1, | ||
| + | 30 => 1, | ||
| + | 31 => 0, | ||
| + | }, | ||
| + | free_addr_skip_default => ' | ||
| + | free_addr_skip_last => ' | ||
| + | fixed_addr_free => ' | ||
| + | </ | ||
| + | |||
| + | |||
| + | ==== Error Codes ==== | ||
| + | |||
| + | The following error codes and messages can be returned by this module in the response attributes **'' | ||
| + | |||
| + | ^Function^Error-code^Message format^ | ||
| + | |add_host|0000|Succesful completed ' | ||
| + | |add_host|0104|Signin to Infoblox failed| | ||
| + | |add_host|0201|Invalid record type ' | ||
| + | |add_host|0202|Invalid hostname ' | ||
| + | |add_host|0203|Invalid domain name ' | ||
| + | |add_host|0204|domain ' | ||
| + | |add_host|0205|Invalid fqdn ' | ||
| + | |add_host|0206|fqdn ' | ||
| + | |add_host|0207|Invalid ipv4 address ' | ||
| + | |add_host|0208|subnet of ipv4 address ' | ||
| + | |add_host|0209|ipv4 address ' | ||
| + | |add_host|0210|Invalid subnet ' | ||
| + | |add_host|0211|Missing address or subnet(s) ' | ||
| + | |add_host|0212|No free addres found in the subnet(s) ' | ||
| + | |add_host|0213|Validation of ext-attr for Arec failed| | ||
| + | |add_host|0214|Validation of ext-attr for Host failed| | ||
| + | |add_host|0215|Missing alias domain in fqdn ' | ||
| + | |add_host|0216|Invalid alias hostname ' | ||
| + | |add_host|0217|Invalid alias domain ' | ||
| + | |add_host|0218|alias domain does not exist ' | ||
| + | |add_host|0219|Invalid alias fqdn ' | ||
| + | |add_host|0220|Validation of ext-attr for Cname failed| | ||
| + | |add_host|0221|Cname could not be created: 'fail reason' | ||
| + | |add_host|0222|No A-record found for ip-migration ' | ||
| + | |add_host|0223|Validation of ext-attr for Host failed| | ||
| + | |add_host|0224|Updating Arec ' | ||
| + | |add_host|0225|No Host-record found for ip-migration ' | ||
| + | |add_host|0226|Host-record has too many addresses for ip-migration ' | ||
| + | |add_host|0227|Validation of ext-attr for Host failed| | ||
| + | |add_host|0228|Updating Host ' | ||
| + | ^ ^^^ | ||
| + | |clear_host|0000|Succesful completed ' | ||
| + | |clear_host|0104|Signin to Infoblox failed| | ||
| + | |clear_host|0301|Invalid record type ' | ||
| + | |clear_host|0302|Invalid fqdn ' | ||
| + | |clear_host|0303|Invalid host ip-address ' | ||
| + | ^ ^^^ | ||
| + | |set_host|0000|Succesful completed ' | ||
| + | |set_host|0104|Signin to Infoblox failed| | ||
| + | |set_host|0351|Invalid record type ' | ||
| + | |set_host|0352|Invalid fqdn ' | ||
| + | |set_host|0353|No ' | ||
| + | |set_host|0354|Validation of ext-attr for Host failed| | ||
| + | |set_host|0355|Validation of ext-attr for Arec failed| | ||
| + | |set_host|0356|Validation of ext-attr for Cname failed| | ||
| + | |set_host|0357|Updating ' | ||
| + | ^ ^^^ | ||
| + | |add_alias|0000|Succesful completed ' | ||
| + | |add_alias|0104|Signin to Infoblox failed| | ||
| + | |add_alias|0401|Invalid record type ' | ||
| + | |add_alias|0402|Invalid hostname ' | ||
| + | |add_alias|0403|Invalid domain name ' | ||
| + | |add_alias|0404|domain ' | ||
| + | |add_alias|0405|Invalid fqdn ' | ||
| + | |add_alias|0406|fqdn ' | ||
| + | |add_alias|0407|no alias to add to canonical ' | ||
| + | |add_alias|0408|Missing alias domain in fqdn ' | ||
| + | |add_alias|0409|Invalid alias hostname ' | ||
| + | |add_alias|0410|Invalid alias domain ' | ||
| + | |add_alias|0411|alias domain does not exist ' | ||
| + | |add_alias|0412|Invalid alias fqdn ' | ||
| + | |add_alias|0413|Validation of ext-attr for Cname failed| | ||
| + | |add_alias|0414|Cname could not be created: 'fail reason' | ||
| + | ^ ^^^ | ||
| + | |clear_alias|0000|Succesful completed ' | ||
| + | |clear_alias|0104|Signin to Infoblox failed| | ||
| + | |clear_alias|0501|Invalid record type ' | ||
| + | |clear_alias|0502|Invalid fqdn ' | ||
| + | |clear_alias|0503|no alias to clear| | ||
| + | |clear_alias|0504|No Cnames found for ' | ||
| + | |clear_alias|0505|no Cnames removed| | ||
| + | ^ ^^^ | ||
| + | |show_host|0000|Succesful completed ' | ||
| + | |show_host|0104|Signin to Infoblox failed| | ||
| + | |show_host|0601|Invalid record type ' | ||
| + | |show_host|0602|Invalid fqdn ' | ||
| + | |show_host|0603|No Host-record found for ' | ||
| + | |show_host|0604|No A-record found for ' | ||
| + | |show_host|0605|No Cname-record found for ' | ||
| + | ^ ^^^ | ||
| + | |show_subnet|0000|Succesful completed ' | ||
| + | |show_subnet|0104|Signin to Infoblox failed| | ||
| + | |show_subnet|0701|Invalid ipv4 subnet address ' | ||
| + | |show_subnet|0702|subnet ' | ||
| + | ^ ^^^ | ||
| + | |make_host|0801|Create Host for ' | ||
| + | |make_host|0802|Adding Host for ' | ||
| + | |make_arec|0811|Create Arecord for ' | ||
| + | |make_arec|0812|Add Arecord for ' | ||
| + | |make_cname|0821|Create Cname ' | ||
| + | |make_cname|0822|Adding Cname ' | ||
| + | |make_host_alias|0831|No Host-record found for ' | ||
| + | |make_host_alias|0832|Validation of ext-attr for Host failed| | ||
| + | |make_host_alias|0833|Updating Host ' | ||
| + | |del_host|0841|Removing complete Host for ' | ||
| + | |del_host|0842|Updating Host ' | ||
| + | |del_host|0843|Removing Host for ' | ||
| + | |del_host|0844|No Host for ' | ||
| + | |del_host|0845|No Host found for ' | ||
| + | ^ ^^^ | ||
| + | |del_arec|0901|Remove Arecord for ' | ||
| + | |del_arec|0902|Remove Arecord for ' | ||
| + | |del_arec|0903|No Arecords for ' | ||
| + | |del_arec|0904|No Arecord found for ' | ||
| + | |del_cname|0911|No Cname found for ' | ||
| + | |del_cname|0912|Remove Cname for ' | ||
| + | |del_host_alias|0921|No Host found for ' | ||
| + | |del_host_alias|0922|Updating Host ' | ||
| + | |||
| + | |||