Cluster Server 7.4.1 Bundled Agents Reference Guide - AIX

Last Published:
Product(s): InfoScale & Storage Foundation (7.4.1)
Platform: AIX
  1. Introducing Bundled agents
    1.  
      About Bundled agents
    2.  
      Resources and their attributes
    3.  
      Modifying agents and their resources
    4.  
      Attributes
    5.  
      WPAR-aware agents
    6.  
      IMF-aware agents
    7.  
      Enabling debug log messages
    8.  
      VCS support for multi-pathing solutions
  2. Storage agents
    1.  
      About the storage agents
    2. DiskGroup agent
      1.  
        IMF awareness
      2.  
        Support for online migration for DiskGroup agent
      3.  
        Dependencies for DiskGroup agent
      4.  
        Agent functions for DiskGroup agent
      5.  
        State definitions for DiskGroup agent
      6.  
        Attributes for DiskGroup agent
      7.  
        Resource type definition
      8. Notes for DiskGroup agent
        1.  
          High availability fire drill
        2.  
          Using volume sets
        3. Setting the noautoimport flag for a disk group
          1.  
            VxVM noautoimport flag usage
        4.  
          Configuring the Fiber Channel adapter
        5.  
          Using the DiskGroup agent with IMF
        6.  
          Using Cluster Server with virtual SCSI devices
        7.  
          Using the DiskGroup agent with NFS
      9. Sample configurations for DiskGroup agent
        1.  
          DiskGroup resource configuration
      10.  
        Debug log levels for DiskGroup agent
    3. DiskGroupSnap agent
      1.  
        Dependencies for DiskGroupSnap agent
      2.  
        Agent functions for DiskGroupSnap agent
      3.  
        State definitions for DiskGroupSnap agent
      4.  
        Attributes for DiskGroupSnap agent
      5. Notes for DiskGroupSnap agent
        1.  
          Fire drill configuration after upgrading VCS
        2.  
          Configuring the SystemZones attribute for the fire drill service group
        3.  
          Configuring the FireDrill service group
        4.  
          Adding the ReuseMntPt attribute to the ArgList attribute for the Mount agent type
        5.  
          Configuration considerations
        6.  
          Agent limitations
      6.  
        Resource type definition for DiskGroupSnap agent
      7. Sample configurations for DiskGroupSnap agent
        1.  
          Typical main.cf configuration for DiskGroupSnap agent
        2.  
          Sample main.cf of DiskGroupSnap with Oracle resource
      8.  
        Debug log levels for DiskGroupSnap agent
    4. Volume agent
      1.  
        Dependencies for Volume agent
      2.  
        Agent functions for Volume agent
      3.  
        State definitions for Volume agent
      4.  
        Attributes for Volume agent
      5.  
        Resource type definition for Volume agent
      6.  
        Sample configuration for Volume agent
      7.  
        Debug log levels for Volume agent
    5. VolumeSet agent
      1.  
        Dependencies for VolumeSet agent
      2.  
        Agent functions for VolumeSet agent
      3.  
        State definitions for VolumeSet agent
      4.  
        Attributes for VolumeSet agent
      5.  
        Resource type definition for VolumeSet agent
      6. Sample configurations for VolumeSet agent
        1.  
          A configured VolumeSet that is dependent on a DiskGroup resource
      7.  
        Agent notes for VolumeSet agent
      8.  
        Inaccessible volumes prevent the VolumeSet agent from coming online
      9.  
        Debug log levels for VolumeSet agent
    6. LVMVG agent
      1.  
        Dependencies for LVMVG agent
      2.  
        Agent functions for LVMVG agent
      3.  
        State definitions for LVMVG agent
      4.  
        Attributes for LVMVG agent
      5.  
        Resource type definition for LVMVG agent
      6. Notes for LVMVG agent
        1.  
          Disks renamed after device renaming
        2.  
          About the updatepv action
        3.  
          LVMVG support in a VIO server environment
        4.  
          Deactivation failure using the varyoffvg command on losing storage connectivity
        5.  
          LVMVG Agent Supports JFS or JFS2
        6.  
          Volume group needs to be imported
        7.  
          Varyonvg options
        8.  
          SyncODM Attribute
        9.  
          Major Numbers
        10.  
          Autoactivate Options
        11.  
          LVMVG agent support for the Subsystem Device Driver (SDD)
        12.  
          LVMVG agent support for the Hitachi's HiCommand Dynamic Link Manager (HDLM)
        13.  
          LVMVG agent support for the EMC PowerPath
        14.  
          The hadevice utility
        15.  
          Removing a ghost disk from VxVM control
      7.  
        Sample configuration for LVMVG agent
      8.  
        Debug log levels for LVMVG agent
    7. Mount agent
      1.  
        IMF awareness
      2.  
        Dependencies for Mount agent
      3.  
        Agent functions for Mount agent
      4.  
        State definitions for Mount agent
      5.  
        Attributes for Mount agent
      6.  
        Resource type definition for Mount agent
      7.  
        Notes for Mount agent
      8.  
        High availability fire drill
      9.  
        VxFS file system lock
      10.  
        IMF usage notes
      11.  
        IPv6 usage notes
      12.  
        Bringing a Mount resource online in the WPAR
      13.  
        Selecting the attribute values for a Mount resource for the WPAR's root file system for NFS mounts
      14.  
        Support for namefs file system
      15.  
        Taking a group with the Mount resource offline can take several minutes if the file system is busy
      16.  
        Example 1
      17.  
        Example 2
      18.  
        Example 3
      19.  
        Enabling Level two monitoring for the Mount agent
      20. Sample configurations for Mount agent
        1.  
          Configuration 1 for Mount agent
        2.  
          Configuration 2 for Mount agent
        3.  
          Configuration 3 for AIX for Mount agent
      21.  
        Debug log levels for Mount agent
    8. SFCache agent
      1.  
        Resource dependency
      2.  
        Agent functions
      3.  
        State definitions
      4.  
        Attributes
      5.  
        Resource type definition
      6. Notes for SFCache agent
        1.  
          Configuring SFCache resource with CVM/CFS
      7.  
        Debug log levels
  3. Network agents
    1. About the network agents
      1. Agent comparisons
        1.  
          IP and NIC agents
        2.  
          IPMultiNIC and MultiNICA agents
        3.  
          IPMultiNICB and MultiNICB agents
        4.  
          802.1Q trunking
        5.  
          EtherChannel support
    2. IP agent
      1.  
        High availability fire drill for IP agent
      2.  
        Dependencies for IP agent
      3.  
        Agent functions for IP agent
      4.  
        State definitions for IP agent
      5.  
        Attributes for IP agent
      6.  
        Resource type definition for IP agent
      7. Sample configurations for IP agent
        1.  
          NetMask in decimal (base 10)
        2.  
          NetMask in hexadecimal (base 16)
      8.  
        Debug log levels for IP agent
    3. NIC agent
      1.  
        Dependencies for NIC agent
      2.  
        Agent functions for NIC agent
      3.  
        State definitions for NIC agent
      4.  
        Attributes for NIC agent
      5.  
        Resource type definition for NIC agent
      6. Notes for the NIC agent
        1.  
          High availability fire drill for NIC agent
      7. Sample configurations for NIC agent
        1.  
          Configuration without network hosts (using default ping mechanism) for NIC agent
        2.  
          Configuration with network hosts for NIC agent
      8.  
        IPv6 configuration for NIC agent
      9.  
        Debug log levels for NIC agent
    4. IPMultiNIC agent
      1.  
        Dependencies for IPMultiNIC agent
      2.  
        Agent functions for IPMultiNIC agent
      3.  
        State definitions for IPMultiNIC agent
      4.  
        Attributes for IPMultiNIC agent
      5.  
        Resource type definition for IPMultiNIC agent
      6. Sample configuration: IPMultiNIC and MultiNICA
        1.  
          Configuration for IPMultiNIC agent
      7.  
        Debug log levels
    5. MultiNICA agent
      1.  
        Dependencies for MultiNICA agent
      2.  
        Agent function for MultiNICA agent
      3.  
        State definitions for MultiNICA agent
      4.  
        Attributes for MultiNICA agent
      5.  
        Resource type definition for MultiNICA agent
      6.  
        Notes for MultiNICA agent
      7. Sample configurations for MultiNICA agent
        1.  
          MultiNICA and IPMultiNIC
        2.  
          IPv6 configuration for MultiNICA agent
        3.  
          Mix mode configuration for MultiNICA agent
      8.  
        Debug log levels for MultiNICA agent
    6. About the IPMultiNICB and MultiNICB agents
      1.  
        Checklist to ensure the proper operation of MultiNICB
    7. IPMultiNICB agent
      1.  
        Dependencies for IPMultiNICB agent
      2.  
        Requirements for IPMultiNICB
      3.  
        The haipswitch utility for IPMultiNICB agent
      4.  
        Agent functions for IPMultiNICB agent
      5.  
        State definitions for IPMultiNICB agent
      6.  
        Attributes for IPMultiNICB agent
      7.  
        Resource type definition for IPMultiNICB agent
      8. Sample configurations for IPMultiNICB agent
        1.  
          IPMultiNICB and MultiNICB sample configuration
        2.  
          Other sample configurations for IPMultiNICB and MultiNICB
      9.  
        Debug log levels for IPMultiNICB agent
    8. MultiNICB agent
      1.  
        The haping utility for MultiNICB agent
      2.  
        Dependencies for MultiNICB agent
      3.  
        Agent functions for MultiNICB agent
      4.  
        State definitions for MultiNICB agent
      5.  
        Attributes for MultiNICB agent
      6.  
        Resource type definition for MultiNICB agent
      7.  
        Trigger script for MultiNICB agent
      8. Sample configurations for MultiNICB agent
        1.  
          IPMultiNICB and MultiNICB configuration
        2.  
          Mix mode configuration for MultiNICB agent
      9.  
        Debug log levels for MultiNICB agent
    9. DNS agent
      1.  
        Dependencies for DNS agent
      2.  
        Agent functions for DNS agent
      3.  
        State definitions for DNS agent
      4.  
        Attributes for DNS agent
      5.  
        Resource type definition for DNS agent
      6. Agent notes for DNS agent
        1. About using the VCS DNS agent on UNIX with a secure Windows DNS server
          1.  
            Software requirement for DNS agent
          2.  
            Configuration requirement for DNS agent
        2.  
          High availability fire drill for DNS agent
        3.  
          Monitor scenarios for DNS agent
        4.  
          Sample Web server configuration for DNS agent
        5.  
          Secure DNS update for BIND 9 for DNS agent
        6.  
          Setting up secure updates using TSIG keys for BIND 9 for DNS agent
      7. Sample configurations for DNS agent
        1.  
          Basic IPv6 configuration for DNS agent
        2.  
          IPv6 CNAME sample configuration for DNS agent
        3.  
          IPv4 A sample configuration for DNS agent
      8.  
        Debug log levels for DNS agent
  4. File share agents
    1.  
      About the file service agents
    2. NFS agent
      1.  
        Dependencies for NFS agent
      2.  
        Agent functions for NFS agent
      3.  
        State definitions for NFS agent
      4.  
        Attributes for NFS agent
      5.  
        Resource type definition for NFS agent
      6. Notes for NFS agent
        1.  
          Using NFSv4 on AIX
        2.  
          Caveats
      7.  
        Sample configurations for NFS agent
      8.  
        Debug log levels for NFS agent
    3. NFSRestart agent
      1.  
        Dependencies for NFSRestart agent
      2.  
        Agent functions for NFSRestart agent
      3.  
        State definitions
      4.  
        Attributes for NFSRestart agent
      5.  
        Resource type definition for NFSRestart agent
      6. Notes for NFSRestart agent
        1.  
          About high availability fire drill
        2.  
          Providing a fully qualified host name
      7. Sample configurations for NFSRestart agent
        1.  
          Basic agent configurations
      8.  
        Debug log levels for NFSRestart agent
    4. Share agent
      1.  
        Dependencies for Share agent
      2.  
        Agent functions for Share agent
      3.  
        State definitions for Share agent
      4.  
        Attributes for Share agent
      5.  
        Resource type definition for Share agent
      6. Notes for Share agent
        1.  
          High availability fire drill
      7.  
        Sample configurations for Share agent
      8.  
        Debug log levels for Share agent
    5. About the Samba agents
      1.  
        The Samba agents
      2.  
        Before using the Samba agents
      3.  
        Supported versions for Samba agents
      4. Notes for configuring the Samba agents
        1.  
          Configuring multiple SambaServer resources
        2.  
          Configuring Samba for non-standard configuration files or non-standard lock directories
    6. SambaServer agent
      1.  
        Dependencies for SambaServer agent
      2.  
        Agent functions for SambaServer agent
      3.  
        State definitions for SambaServer agent
      4.  
        Attributes for SambaServer agent
      5.  
        Resource type definitions for SambaServer agent
      6.  
        Notes for SambaServer agent
      7.  
        Sample configurations for SambaServer agent
      8.  
        Debug log levels for SambaServer agent
    7. SambaShare agent
      1.  
        Dependencies for SambaShare agent
      2.  
        Agent functions for SambaShare agent
      3.  
        State definitions for SambaShare agent
      4.  
        Attributes for SambaShare agent
      5.  
        Resource type definition for SambaShare agent
      6.  
        Sample configuration for SambaShare agent
      7.  
        Debug log levels for SambaShare agent
    8. NetBios agent
      1.  
        Dependencies for NetBios agent
      2.  
        Agent functions for NetBios agent
      3.  
        State definitions for NetBios agent
      4.  
        Attributes for NetBios agent
      5.  
        Resource type definition for NetBios agent
      6.  
        Sample configuration for NetBios agent
      7.  
        Debug log levels for NetBios agent
  5. Service and application agents
    1.  
      About the services and applications agents
    2. Apache HTTP server agent
      1.  
        Dependencies
      2.  
        Agent functions
      3.  
        State definitions
      4.  
        Attributes
      5.  
        Resource type definition
      6. Apache HTTP server notes
        1.  
          Tasks to perform before you use the Apache HTTP server agent
        2.  
          About detecting application failure
        3.  
          About bringing an Apache HTTP server online outside of VCS control
        4.  
          About high Availability fire drill
        5.  
          Using Apache agent with IMF
      7. Sample configurations
        1.  
          Basic IPv6 configuration
        2.  
          Sample output of the amfstat command
      8.  
        Debug log level
    3. Application agent
      1.  
        IMF awareness
      2.  
        High availability fire drill for Application agent
      3.  
        Dependencies for Application agent
      4.  
        Agent functions
      5.  
        State definitions for Application agent
      6.  
        Attributes for Application agent
      7.  
        Resource type definition for Application agent
      8. Notes for Application agent
        1.  
          Using Application agent with IMF
        2.  
          Level two monitoring through MonitorProgram
        3.  
          Using Application agent with ProPCV
        4.  
          Requirement for programs
        5.  
          Requirement for default profile
        6.  
          Support for cloned Application agent
      9. Sample configurations for Application agent
        1.  
          Configuration 1 for Application agent
        2.  
          Configuration 2 for Application agent
      10.  
        Debug log levels for Application agent
    4. CoordPoint agent
      1.  
        Coordination Point server as a coordination point
      2.  
        SCSI-3 based disk as a coordination point
      3.  
        Dependencies
      4.  
        Agent functions
      5.  
        State definitions
      6.  
        Attributes
      7.  
        Resource type definition
      8. Notes for the CoordPoint agent
        1.  
          CoordPoint agent I/O fencing reporting activities
        2.  
          AutoStartList attribute
        3.  
          Detailed monitoring for the Coordpoint resource
        4.  
          The ActionOnCoordPointFault attribute set to RefreshRegistrations
      9.  
        Sample configuration
      10.  
        Debug log levels
    5. Process agent
      1.  
        IMF awareness
      2.  
        High availability fire drill for Process agent
      3.  
        Dependencies for Process agent
      4.  
        Agent functions for Process agent
      5.  
        State definitions for Process agent
      6.  
        Attributes for Process agent
      7.  
        Resource type definition for Process agent
      8. Usage notes for Process agent
        1.  
          Prerequisites for processes
      9. Sample configurations for Process agent
        1.  
          Configuration 1 for Process agent
        2.  
          Configuration 2 for Process agent
      10.  
        Debug log levels for Process agent
    6. ProcessOnOnly agent
      1.  
        Dependencies
      2.  
        Agent functions
      3.  
        State definitions
      4.  
        Attributes
      5.  
        Resource type definition
      6. ProcessOnOnly agent usage notes
        1.  
          Requirement for programs
      7.  
        Sample configurations
      8.  
        Debug log levels
    7. WPAR agent
      1.  
        IMF awareness
      2.  
        Dependencies
      3.  
        Agent functions
      4.  
        Attributes
      5.  
        Resource type definition
      6.  
        Sample configuration
      7. WPAR agent notes
        1.  
          Using the WPAR agent with IMF
        2.  
          Configuring the WPAR agent for DR in a Global Cluster environment
        3.  
          Using the IP agent with WPAR
      8.  
        Debug log levels
    8. MemCPUAllocator agent
      1.  
        Dependencies
      2.  
        Agent functions
      3.  
        Attributes
      4.  
        Resource type definition
      5. MemCPUAllocator agent notes
        1.  
          Configuring password free SSH communication between VCS nodes and HMC
        2.  
          Dynamic resource allocation scenarios
        3.  
          Scenario 1: A DLPAR node has minimum resources
        4.  
          Scenario 2: Bringing another service group online
        5.  
          Scenario 3: DLPAR has required resources
        6.  
          Scenario 4: Cannot allocate required resources
        7.  
          Scenario 5: Service group failover
        8.  
          Configuring MemCPUAllocator
      6.  
        Debug log levels
    9. LPAR agent
      1.  
        Dependencies for LPAR agent
      2.  
        Agent functions for LPAR agent
      3.  
        State definitions for LPAR agent
      4.  
        Required attributes for LPAR agent
      5.  
        Optional attributes for LPAR agent
      6.  
        Group attribute for LPAR agent
      7.  
        System attribute for LPAR agent
      8.  
        Resource type definition for LPAR agent
      9.  
        Sample configurations for LPAR agent
      10. Notes for LPAR agent
        1.  
          VCS requirements to manage the LPAR agent
        2.  
          Configuring password-less SSH communication between VCS nodes and HMC
        3.  
          Verifying password-less SSH status
        4.  
          Live Partition Mobility support for LPARs managed by VCS
        5.  
          Setting the SysDownPolicy attribute for the LPAR service group
        6.  
          Configuring the LPAR agent for DR in a Global Cluster environment
      11.  
        Debug log levels for LPAR agent
  6. Infrastructure and support agents
    1.  
      About the infrastructure and support agents
    2. NotifierMngr agent
      1.  
        Dependency
      2.  
        Agent functions
      3.  
        State definitions
      4.  
        Attributes
      5.  
        Resource type definition
      6. Sample configuration
        1.  
          Configuration
        2.  
          IPv6 configuration for AIX
      7.  
        Debug log levels
    3. Proxy agent
      1.  
        Dependencies
      2.  
        Agent functions
      3.  
        Attributes
      4.  
        Resource type definition
      5. Sample configurations
        1.  
          Configuration 1
        2.  
          Configuration 2
        3.  
          Configuration 3
      6.  
        Debug log levels
    4. Phantom agent
      1.  
        Dependencies
      2.  
        Agent functions
      3.  
        Resource type definition
      4. Sample configurations
        1.  
          Configuration 1
        2.  
          Configuration 2
    5. RemoteGroup agent
      1.  
        Dependency
      2.  
        Agent functions
      3.  
        State definitions
      4.  
        Attributes
      5.  
        Resource type definition
      6.  
        Debug log levels
  7. Testing agents
    1.  
      About the testing agents
    2. ElifNone agent
      1.  
        Dependencies for ElifNone agent
      2.  
        Agent function for ElifNone agent
      3.  
        State definitions for ElifNone agent
      4.  
        Attributes for ElifNone agent
      5.  
        Resource type definition for ElifNone agent
      6.  
        Sample configuration for ElifNone agent
      7.  
        Debug log levels for ElifNone agent
    3. FileNone agent
      1.  
        Dependencies for FileNone agent
      2.  
        Agent functions for FileNone agent
      3.  
        State definitions for FileNone agent
      4.  
        Attribute for FileNone agent
      5.  
        Resource type definition for FileNone agent
      6.  
        Sample configuration for FileNone agent
      7.  
        Debug log levels for FileNone agent
    4. FileOnOff agent
      1.  
        Dependencies for FileOnOff agent
      2.  
        Agent functions for FileOnOff agent
      3.  
        State definitions for FileOnOff agent
      4.  
        Attribute for FileOnOff agent
      5.  
        Resource type definition for FileOnOff agent
      6.  
        Sample configuration for FileOnOff agent
      7.  
        Debug log levels for FileOnOff agent
    5. FileOnOnly agent
      1.  
        Dependencies for FileOnOnly agent
      2.  
        Agent functions for FileOnOnly agent
      3.  
        State definitions for FileOnOnly agent
      4.  
        Attribute for FileOnOnly agent
      5.  
        Resource type definition for FileOnOnly agent
      6.  
        Sample configuration for FileOnOnly agent
      7.  
        Debug log levels for FileOnOnly agent
  8. Replication agents
    1.  
      About the replication agents
    2. RVG agent
      1.  
        Dependencies
      2.  
        Agent functions
      3.  
        State definitions
      4.  
        Attributes
      5.  
        Resource type definitions
      6.  
        Sample configurations
    3. RVGPrimary agent
      1.  
        Dependencies
      2.  
        Agent functions
      3.  
        State definitions
      4.  
        Attributes
      5.  
        Resource type definitions
      6.  
        Sample configurations
    4. RVGSnapshot
      1.  
        Dependencies
      2.  
        Agent functions
      3.  
        State definitions
      4.  
        Attributes
      5.  
        Resource type definitions
      6.  
        Sample configurations
    5. RVGShared agent
      1.  
        Dependencies
      2.  
        Agent functions
      3.  
        State definitions
      4.  
        Attributes
      5.  
        Resource type definitions
      6.  
        Sample configurations
    6. RVGLogowner agent
      1.  
        Dependencies
      2.  
        Agent functions
      3.  
        State definitions
      4.  
        Attributes
      5.  
        Resource type definitions
      6.  
        RVGLogowner agent notes
      7.  
        Sample configurations
    7. RVGSharedPri agent
      1.  
        Dependencies
      2.  
        Agent functions
      3.  
        State definitions
      4.  
        Attributes
      5.  
        Resource type definitions
      6.  
        Sample configurations

Attributes for DNS agent

Table: Required attributes

Required attribute

Description

Domain

A string representing the DNS zone that the agent administers.

The domain name can only contain alphanumeric symbols and the dash.

Type and dimension: string-scalar

Examples:

  • Forward mapping: "demo.example.com"

  • IPv4 reverse mapping: "2.168.192.in-addr.arpa"

ResRecord

ResRecord is an association of DNS resource record values. Each ResRecord attribute consists of two values: DNS record key = DNS record data. Note that the record key must be a unique value.

If the resource record list contains any invalid value as a part of the record key or a record data of the ResRecord attribute, the resource reports an UNKNOWN state.

Type and dimension: string-association

Examples:

  • For forward mapping, where the zone is demo.example.com:

    - aix901 = "192.168.2.191"

    - ww2 = aix901

    - aix9ip6 = "2007::1:2:3:abc"

  • For a multi-home DNS record, typically for one host with two network interfaces and different addresses, but the same DNS name. The A type ResRecord configuration should be as follows:

    aix902 = "192.168.2.102 10.87.13.22"

    A multi-home AAAA DNS record can be configured as follows:

    aix902 = "1234::5678 1234::AABB:CCDD"

  • For reverse IPv4 address mapping, where the zone is 2.168.192.in-addr.arpa:

    191 = "aix901.demo.example.com"

  • For reverse IPv6 address mapping:

    • For 2620:128:f0a2:9001::/64 IPv6 Address prefix, the reverse lookupzone will be 1.0.0.9.2.a.0.f.8.2.1.0.0.2.6.2.ip6.arpa

    • If you want to create PTR record for 2620:128:f0a2:9001::102:108 address, you must mention 1020108 as key value in the ResRecord attribute.

      That is, ResRecord={1020108="aix9ip6.demo.example.com"}

Use only partial host names. If you use a fully qualified domain name, append a period "." at the end of the name.

For CNAME records, use:

  • ResRecord = { www = mydesktop }

    or

  • ResRecord = { www = "mydesktop.marketing.example.com." }

    Where the Domain attribute is "marketing.example.com"

ResRecord (Continued)

The agent uses case-insensitive pattern matching - and a combination of the Domain and ResRecord attribute values - to determine the resource record type. The RR types are as follows:

  • PTR: if the Domain attribute ends with .arpa

  • A: if the record data field is an IPv4 address (four sets of numbers, where a period separates each set. The following details the pattern it tries to match: [1-223].[0-255].[0-255].[0-255] Hexadecimal is not supported.)

  • AAAA: if the record data fields are in multiple sets of hexadecimal format, then this record is an IPv6 associated type AAAA record.

  • CNAME: for any other valid record data.

Note:

If a name in the ResRecord attribute does not comply with RFC 1035, then the agent logs a warning message to the engine log file. This ResRecord association is not used. As an exception to this, the DNS agent allows underscore character ("_") in hostnames. Make sure that the DNS server supports the underscore character before you configure any DNS resource records to have the underscore character in their hostnames.

Table: Optional attributes

Optional attribute

Description

TTL

This attribute (a non-zero integer) represents the Time To Live (TTL) value, in seconds, for the DNS entries in the zone that you want to update.

A lower value means more hits on your DNS server, while a higher value means more time for your clients to learn about changes.

The TTL may take the value 0, which indicates never caching the record, to a maximum of 2,147,483,647, which is over 68 years! The current best practice recommendation (RFC 1912) proposes a value greater than one day, and on RRs that do not change often, consider multi-week values.

Type and dimension: integer-scalar

Default: 86400

Example: 3600

StealthMasters

The list of primary master name servers in the domain.

This attribute is optional since the first name server is retrieved from the zone's SOA (Start of Authority) record.

If the primary master name server is a stealth server, define this attribute. A stealth server is a name server that is authoritative for a zone, but does not appear in that zone's SOA record. It is hidden to prevent direct attacks from the Internet.

Type and dimension: string-vector

Example: {"10.190.112.23", "2620:128:f0a2:9001::102:108"}

TSIGKeyFile

Required when you configure DNS for secure updates. Specifies the absolute path to the file containing the private TSIG (Transaction Signature) key. This attribute should be configured only when the DNS server configured is a Unix based DNS server.

Type and dimension: string-scalar

Example:

/var/tsig/example.com.+157+00000.private

CreatePTR

Use the CreatePTR attribute to direct the online agent functions to create PTR records for each RR of type A or AAAA. You must set the value of this attribute to true (1) to create the records. Before you can use this attribute, make sure that the same master or stealth servers serve the forward (A or AAAA) and reverse zones.

Type and dimension: boolean-scalar

Default: 0

Example: 1

OffDelRR

Use the OffDelRR attribute to direct the offline and clean agent functions to remove all records that the ResRecord key defines. You must set the value of this attribute to 1 (true) to have the agent remove all the records.

Type and dimension: boolean-scalar

Default: 0

Example: 1

UseGSSAPI

Use the UseGSSAPI attribute if the DNS server that you have configured is a Windows DNS server and only if it accepts secure dynamic updates.

Note:

Do not set this attribute if the Windows DNS server accepts non-secure updates.

If this attribute is set to 1, the agent uses the -g option with the nsupdate command.

See Agent notes for DNS agent. for more information on requirements to use the DNS agent with the secure Windows DNS server.

Type and dimension: boolean-scalar

Default: 0

Example: 1

RefreshInterval

This attribute represents the time interval in seconds after which the DNS agent attempts to refresh the resource records (RRs) on the DNS servers. The default value of zero indicates that the DNS agent does not attempt to refresh the records on the DNS servers. The DNS agent writes the warning message to the logs if it is not able to refresh the DNS records.

Note:

The refresh request is sent in the next monitor cycle after the RefreshInterval period is reached.

If the DNS agent is unable to refresh the DNS records, and the records are removed as a result of a scavenging operation or by the DNS administrator, the DNS resource will fault.

Type and dimension: integer-scalar

Default: 0

Example: 3600

CleanRRKeys

Use this attribute to direct the online agent function to clean up all the existing DNS records for the configured keys before adding new records. The default value (0) disables this behavior.

Note:

If multiple DNS resources are configured with the same key value in their ResRecord attribute, then do not set this attribute value to 1.

Type and dimension: boolean-scalar

Default: 0

Example: 1