{{indexmenu_n>4}} ===== Infoblox DNS API plugin ===== > This functionality is dependent on the ''Infoblox'' license key. 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, an extensive set of customizable policies have been defined to control the process further. The assignment of Infoblox Extensible-attibutes is fully supported. ==== Integration configuration ==== The Infoblox integration is setup using the configuration file "**YCE Infoblox integration**" available through the "Admin - System - Edit configs" tool and uses the file ''/opt/yce/etc/_dhcp.conf''. 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, A-records or Cnames from the DNS using or is a canonical to a given ip-address.| |Set_host|Update attributes of an existing Host, A-record or Cname. Supported attributes are 'comment', 'disable', 'ttl' and 'extensible_attributes'| |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, A-record or Cname| |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, A-records and Cnames| |Dns_report|Is an alternate name to the 'host_report' request| |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.



  
  
    
       10.33.44.10/25

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.



  
  
    
        
        
        
        
        
        
       10.33.43.10/25
       new-hostname-ref.some.domain.name
       alternate-name.another.domain.name

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.



  
  
    
       10.66.77.0/25
       10.66.77.0/28

== 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 ''**new_ip_addr="yes"**''. When set yo "yes", it will determine the new ip-address from the ''ipv4_addr=".."'' attribute or from the ''subnet_addr=".."'', identical to the regular Add_host call. Only the validation of the fqdn is reversed: with the ''new_ip_addr="yes"'' the fqdn **must** exist as the record type specified, when ''new_ip_addr="no"'' the fqdn **may not** exist. This example also demonstrates the use of the attributes ''**disable**'' and ''**ttl**''.



  
  
    
       
       10.66.44.12/25

== 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 ''etc/_dhcp.conf'', the same file that has the Infoblox GridMaster address and credentials. When not using the default views, they can be specified using the ''**ipam_view**'' and ''**dns_view**'' attributes.



  
  
    
     80.90.100.200/18
     baba:bebe:3100::200/120

== Attributes == ^Attribute name^Object^Values^Description^ |**log_level**|head|'0' or '1'|When set to a value greater than 0, a full set of log messages is included in the XML response| |**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|'host' or 'arec'|The record type, 'Host-record' or 'A-record', to be created.| |**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|'yes' or 'no'|When set to 'yes' the host record will be disabled, otherwise it will be enabled. Attribute is optional, default is "no"| |**ttl**|host|'0' thru '4294967295' or 'inherit'|Determines the 'time-to-live' in seconds that the entry my be cached. '0' denotes no caching. the value 'inherit' removes the ttl value from the record which will then be inherited| |**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 ''ipv4_addr'' attribute is present, any ''subnet_addr'' attribute is ignored. Only the first ''ipv4-addr'' specified will be used. >> CHECK If the address is in use, the request will be rejected| |**subnet_addr**|host|network-address with prefix|The first free ip-address is used for the new DNS record. Multiple ''subnet_addr'' attributes may be added to allow for continued searching for a free address should they be exhausted. Policies define if and what addresses should be skipped. A address is considered free when it is not assigned an fqdn or is part of a DHCP scope. These attributes will be ignored when an ''ipv4_addr'' attribute is present.| |**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 ''ipv6-addr'' specified will be used. The ipv6_address can only be used for 'host' records at this time, AAAA-record support is planned. The IPAM-view of the ipv4 and ipv6 addresses must match.| |**alias**|host|fqdn|The full qualified domain name of the 'Host-alias' or 'Cname-record' to be created. The fqdn may not exist in the DNS. Various policies control the validation of the alias names (hostname and zone).| |**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.| |**ipam_view**|host|IPAM-view name|specify the Infoblox IPAM-view. The default is configured in 'etc/_dhcp.conf' which is normally 'Default'| |**dns_view**|host|DNS-view name|specify the Infoblox DNS-view. The default is configured in 'etc/_dhcp.conf' which is normally 'Intern'. The DNS-view is hierarchically dependent on the IPAM-view| 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 ''name'' attributes are present.

==== Clear_host ==== Remove Host-record or A-record. Optionally remove referring Cnames too.

== Attributes == ^Attribute name^Object^Values^Description^ |**log_level**|head|'0' or '1'|When set to a value greater than 0, a full set of log messages is included in the XML response| |**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 'Intern'| |**network_view**|IPAM view name|Default|Optional attribute that specifies the IPAM view where the ip-address will be searched in. Defaults to 'Default'| ==== Set_host ==== Update attributes of a Host-record, A-record, or Cname. The available DNS record attributes are: 'comment', 'disable', 'ttl', and 'extensible_attributes'.



  
  
    
       
       some-hostname-ref.some.domain.name
       alternate-name.another.domain.name



  
  
    
       some-hostname-ref.some.domain.name
       alternate-name.another.domain.name

The value controls if a "host"-alias or "cname" is to be be removed. Default is "cname". Multiple C-names/host-aliases can be removed for the canonical name by including multiple definitions Attempting to remove an "host"-alias from an A-record as canonical is impossible. The request will be rejected. For 'host'-records the host details (host_fqdn or host_name and host_domain) are mandatory, for 'cname'-records the host details are optional. For a 'host'-record this is a hard dependency. 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 or tags are hardly worth the trouble: the record to attach them to will be deleted. However, for process tracking, its use could be desirable ^Attribute name^Object^Values^Description^ |**log_level**|head|'0' or '1'|When set to a value greater than 0, a full set of log messages is included in the XML response| |**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/_dhcp.conf.| |**record_type**|host|'cname' or 'host'|The alias type to be removed: a Cname or Host-alias. The specified host fqdn must exist as either a Host-record or an A-record or the request will be rejected.| |**alias**|host|fqdn|The full qualified domain name of the 'Host-alias' or 'Cname-record' to be removed. The alias fqdn must be the canonical of a Host-record or A-record. If host details are present and the alias lacks a domain, the host domain will be used. There is no (practical) limit to the number of ''alias'' attributes in the request.| ==== Show_host ==== Returns the various attributes for the record requested. The ''record_type'' must match the fqdn of the specified host name and zone. 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.

^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|'host', 'arec' or 'cname'|The record_type of the requested fqdn| ==== 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.

==== Subnet_report ==== The Infoblox subnet report delivers an XML report on all active subnets defined in the Infoblox IPAM.

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):

:::

==== 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).

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):

:::

==== ExtAttr_report ==== >> Note: This report is not yet available for production (oct 2015) 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.

==== Add_static_dhcp ==== Adds a new static dhcp address


    default_host_type => 'host',     # use 'host' or 'arec' as default
    default_alias_type => 'cname',   # use 'cname' or 'alias' as default
    default_clear_cnames => 'yes',   # use 'yes' or 'no' as default (when deleting Host/Arecords)
    unique_addresses => '1',         # 1=reject multiple addresses per host, 0=allow TODO (not needed?)
    unique_fqdn => '1',              # 1=reject multiple records per fqdn, 0=allow
    reject_host_alias => '1',        # 1=reject any host-alias >>>TODO
    fqdn_max_length => '255',        # reject when exceeds
    comment_max_length => '255',     # reject when comment too long
    hostname_min_length => '2',      # reject when shorter
    hostname_underscore => '0',      # replace _ for - when 1
    hostname_dotted_hosts => '0',    # 0=reject, 1=allow
    hostname_special_chars => '1',   # 1=reject, 0=replace special chars
    hostname_start_letter => '1',    # 1=reject unless starting letter, 0=allow
    hostname_trailing_dash => '0',   # 1=reject, 0=allow
    domain_min_length => '2',        # reject when any segment in domain is shorter
    domain_underscore => '0',        # replace _ for - when 1
    domain_special_chars => '1',     # 1=reject, 0=replace special chars
    domain_start_letter => '1',      # 1=reject unless starting letter, 0=allow
    domain_dotted => '1',            # minimum nr of dots in domain
    domain_trailing_dash => '1',     # 1=allow, 0=reject
    domain_must_exist => '1',        # 1=reject unless exists, 0=allow
    subnet_must_exist => '1',        # 1=reject unless in IPAM, 0=allow
    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 => '10',  # all other prefixes skip 10
    free_addr_skip_last => '1',      # 1=skip the last '1' addresses, 0=use it
    fixed_addr_free => '1',          # 1=reject addr in use, 0=use it