Adds a host to the system

• return: Structured response

• struct $p: Associative array with the following fields:
  • mac: MAC-address
  • subnet: Network address of subnet (must already exist in database)
  • ip: IP-address
  • numips: number of IPs (e.g. 1). All IPs must be sequential from "ip"
  • add_ips: OPTIONAL: space seperated string with additional IP-addresses that are not sequential.
  • ipmi_ip: IP-address of IPMI card
  • ipmi_user: IPMI username
  • ipmi_password: IPMI password
  • ipmi_type: IPMI type. v1, v2, v2nokvm or AMT
  • hostname: hostname
  • arch: optional architecture
  • description: description
  • pool: id of pool

Adds a subnet to the system

• return: returns structured result

• struct $p: associative array with the following elements:
  • subnet: network address of subnet (e.g. 10.0.0.0)
  • netmask: netmask (e.g. 255.255.255.0)
  • gateway: IP-address of gateway
  • vlan: Optional VLAN ID. Currently only used for matching IPv4 to IPv6 subnets
  • description: Description

Adds a VPS to the system

• return: Structured response

• struct $p: Associative array with the following fields:
  • subnet: Network address of subnet (must already exist in database)
  • ip: IP-address
  • numips: number of IPs (e.g. 1). All IPs must be sequential from "ip"
  • add_ips: OPTIONAL: space seperated string with additional IP-addresses that are not sequential.
  • hostname: hostname
  • description: description
  • module: hypervisor device module ID
  • memory: amount of memory in MB
  • disk: amount of disk in MB
  • diskstore: OPTIONAL name of disk store
  • network: OPTIONAL name of network to hook up to

Cancels the provisioning of a server

• string $mac: MAC-address

Deletes a device

• string $id

• string|array $mac: MAC-address

Deletes a nic

• string $host: Host
• string $index:

  Index

  Note we currently do not support deleting adapter #0

Delete profile Also deletes cached files if it is the only profile using that cache folder

Throws exception if hosts being provisioned are still depending on it

• int $id: Numeric ID of profile

Deletes a subnet

Throws an exception if the subnet cannot be deleted, for example: when there are still hosts associated with it.

• string|array $subnet: Network address of subnet

Delete a webinterace user

Throws an exception if it is the last admin left

• string $username: Username

Removes downloaded files of profile

• int $profile: Numeric profile ID

Check if there is a new NOC-PS update, and return information

• return: Returns textual string or empty if there is no update

Retrieves information about the available bandwidth data of a host

• return:

  Associate array with the following information:

  • ports: number of switch ports associated with the host
  • start: timestamp of start of data collection
  • last: timestamp of last data colelction

• string $host: MAC-address of server

Retrieves available disk space

• return: Space in MB

Retrieves bandwidth data from all hosts

• return: Array with bw data

• int $start: Start of period requested
• int $end: End of period requested

Get console URL

• return: URL of console

• string $mac: MAC-address of server
• string $ipmi_password: IPMI password (if applicable). Leave blank to use stored password.
• string|bool $restrict_ip: Optional: IP-address of client to restrict access to

Get a list of datastores available at a certain hypervisor

• int $devid: Hypervisor device ID

Retrieve a list of devices

• return: Returns an array of records. Records have the following fields:
  • id
  • ip
  • name
  • type
  • statusmsg

• int $start: offset of first record (first = 0)
• int $limit: maximum number of results

Get a list of inactive profiles

• return: Returns array of records, each record has the fields:

• int $start: offset of first record (first = 0)
• int $limit: maximum number of results

Retrieve all host information from a specific host

• string $mac: MAC-address

Get list of ISO files on server

• return: Returns array of records. Each record has the fields:
  • filename: Name of ISO file
  • size: Size in MB

• int $start: offset of first record (first = 0)
• int $limit: maximum number of results

Get locale settings

• return:

  Struct with the following fields:

  • language: default installation language
  • timezone: default timezone

Retrieves a list of pools

• return: Returns an array of records, having the following fields:
  • id: pool id number
  • name: friendly name
  • description: description of port

Get all information from profile add-on

• return: Returns record with all information

• string $tag: tag
• string $name: name

Get profile number by name

• return: Returns unique ID number, or false/0 if not found

• string $name: Friendly name of profile
• string $arch: Architecture ("amd64" for 64-bit, "x86" for 32-bit)

Retrieve the provisioning status

• return: Returns an array of records. Each record has the following fields:
  • host: MAC-address of server being provisioned
  • hostname: Hostname of server being provisioned
  • profile: Numeric ID number of profile
  • profilename: Friendly name of profile
  • statusmsg: Textual description of status (e.g. "Waiting for reboot")
  • statusprogress: Currently not used. Reserved for percentage.

• int $start: offset of first record (first = 0)
• int $limit: maximum number of results

Get server (MAC-address) by IP-address

• return: Returns MAC address, or false/0 if not found

• string $ip: IP-address

Retrieve all subnet information

• return: array of records. Each record is an associative array with the following fields:
  • subnet
  • netmask
  • gw
  • descr

• int $start: offset of first record (first = 0)
• int $limit: maximum number of results

Get ports from device, that are not assigned to other servers yet

• int $devid: Device ID

Retrieve version information

• return: Returns version

Check if an IP-address is already in use by another server (according to the database)

• return: returns true if in use

• string $ip: IP-address to check

Check if an IP-address is already in use BY ANOTHER SERVER then the one specified

• return: returns true if in use

• string $ip
• string $server: MAC-address of server

Send an IPMI command to server

To be able to use IPMI password stored in database: use submitIPMI() instead

• see: PXE_API::submitIPMI()

• string $ip: IP-address of IPMI card
• string $type: IPMI version/type. "v1", "v2", "v2nokvm" or "AMT"
• string $user: IPMI username
• string $password: IPMI password
• string $cmd: Raw IPMI command

Retrieves information about the hosts secondary network interfaces

• return: Structured response

• string $host: Host

Performs an ICMP echo request

• return: Returns true if there is a response
• see: PXE_API::arpPing()

• string $ip: IP-address

Grab a single server from the specificied pool and move it to a new pool Atomic operation (database table locked during operation)

• return: Returns the MAC-address of the server moved, or false if no server is available

• int $pool: Old pool ID
• int $moveToPool: New pool ID

Provisions a server

The server must already be in the system. If it is not, add it with AddHost

• return: Returns structured response
• see: PXE_API::getProfileByName()
• see: PXE_API::addHost()

• struct $p:

  Associative array with the following fields:

  • mac: MAC-address
  • hostname: New hostname of server
  • rootpassword, rootpassword2: Root password (twice)
  • adminuser: Username of optional user
  • userpassword, userpassword2: Password of optional user (twice)
  • rebootmethod: ipmi, apcpdu, webresetter, auto, or empty for manual
  • ipmipassword: IPMI password to set boot method and reboot (optional)
  • profile: Profile ID number
  Optional, overriding profile defaults:
  • disklayout: Disk layout in profile specific format
  • packages: List of packages
  • pre_installation: Pre-installation script (not supported by every profile)
  • post_installation: Post-installation script (usually executed at the end of the installation, before reboot)
  • firstboot: First boot script (executed after installation, after reboot)
  • timezone: Server's timezone
  • language: Language pack to install
  -OR-
  • disk_addon: Reference to disk layout tag/name (e.g. "kickstart:raid1")
  • packages_addon: Reference to package list tag/name (e.g. "ubuntu:lamp")
  • extra_addon1 ... extra_addon10: Extra settings. Usually post-installation scripts. Maximum of 10 items.
  Optional for integration with 3rd party software:
  • callback: URL to be called when provisioning is finished. The MAC addresses of the host will be appended to the URL as GET parameter.
  Caveats:
  • Do not override both the profile defaults and use add-ons at the same time.
  • You should NOT set parameters to empty, if you do not want to use them. e.g. setting "packages" to "", will result in 0 packages being installed If that is not your intention, and you would like to install the default packages listed in the profile, you should leave out the parameter completely, instead of setting it to empty.

Search hosts

• struct $p: containing:
  • subnet OR device OR pool OR rack OR query

Update locale settings

• struct $d

Splits a subnet into smaller ones

The subnet must be empty, it may not have any hosts associated with it.

• struct $p: associative array with the following elements: *
  • subnet: Network address of subnet
  • cidr: CIDR of new subnet (e.g. "30" to split into \30 subnets)
  • gateway: "first" to indicate the gateway is the first usable IP of subnet, "last" for last IP, or "none"

Start KVM/QEMU environment

• return: Returns structured response

• struct $p: Associative array with the following fields:
  • rootpassword: VNC password (8 characters max)
  • iso: optional filename of ISO file
  • storage: optional storage mode (ide, scsi, virtio)
  • network: optional networking mode (none, user)

Send an IPMI command to server (array version)

• return: Returns structured response

• struct $d: associative array with fields:
  • ip
  • username
  • password (if not in database)
  • ipmi_type (v1, v2 or AMT)
  • cmd

Add or update a pool

• struct $p: Associate array with the following fields:
  • id: pool id number (only if updating a pool)
  • name: name of pool
  • description: description

Add or update add-on

• return: Returns structured response

• struct $p: Associative array

Updates host information You must update all fields at once. MAC address and subnet cannot be changed.

• return: Structured response

• struct $p: Associative array with the following fields:
  • mac: MAC-address
  • ip: IP-address
  • add_ips: OPTIONAL: space seperated string with additional IP-addresses that are not sequential
  • subnet: OPTIONAL: network IP-address of new subnet
  • ipmi_ip: IP-address of IPMI card
  • ipmi_user: IPMI username
  • ipmi_password: IPMI password
  • ipmi_noverify: if set, do not verify IPMI password. Default is to connect to the IPMI unit and verify password upon calling updateHost()
  • ipmi_type: v1, v2, v2nokvm or AMT
  • hostname: hostname
  • dhcp: boolean, true if we act as permanent DHCP server for this host
  • pool: pool id number
  • subnet6: IPv6 subnet
  • add_ips6: Space seperated string with IPv6 address(es). All must be within the subnet specified by subnet6

Updates an IPv6 subnet NOTE: subnet and cidr values CANNOT be changed, only gateway, vlan and description

• return: returns structured result

• struct $p: associative array with the following elements:
  • subnet: network address of IPv6 subnet
  • gateway: IP-address of gateway
  • description: Description
  • vlan: Optional VLAN ID