fuel/prototypes/auto-deploy/documentation/5-dea-api.txt

   1 The structure is being reworked. This page describes the DEA interface.
   2
   3 The DEA API is internal to the deployer, but documented here for information.
   4
   5 *** DEA API definition version 1.1 ***
   6
   7 # Get the DEA API version supported by this adapter
   8 dea_getApiVersion ()
   9
  10 # Node numbering is sequential.
  11 # Get the role for this node
  12 # Argument 1: node id
  13 dea_getNodeRole()
  14
  15 # Get IP address of Fuel master
  16 dea_getFuelIp()
  17
  18 # Get netmask Fuel master
  19 dea_getFuelNetmask()
  20
  21 # Get gateway address of Fuel master
  22 dea_getFuelGateway()
  23
  24 # Get gateway address of Fuel master
  25 dea_getFuelHostname()
  26
  27 # Get DNS address of Fuel master
  28 dea_getFuelDns()
  29
  30 # Convert a normal MAC to a Fuel short mac for --node-id
  31 dea_convertMacToShortMac()
  32
  33 # Get property from DEA file
  34 # Argument 1: search path, as e.g. "fuel ADMIN_NETWORK ipaddress"
  35 dea_getProperty()
  36
  37 # Convert DHA node id to Fuel cluster node id
  38 # Look for lowest Fuel node number, this will be DHA node 1
  39 # Argument: node id
  40 dea_getClusterNodeId()
  41
  42 # Entry point for dea functions
  43 # Typically do not call "dea_node_zeroMBR" but "dea node_ZeroMBR"
  44 # Before calling dea, the adapter file must gave been sourced with
  45 # the DEA file name as argument
  46 dea()
  47