Hydra documentation
Page tree
Skip to end of metadata
Go to start of metadata

The equipment can be loaded at the Service Provider Console application of Hydra via the Bulk Actions → Load Equipment menu. If you want to do this yourself, we recommend that you try it on a test instance of Hydra first.

File format

  • The file content format is CSV.

  • UTF-8 encoding is used for text.

  • No text separator (quotation marks around values) is used.

  • Fields (columns) are separated by semicolons — ;

  • Field separators are not allowed in values. If a semicolon is required in values, another printable character can be used as a field separator.

  • A header row with field names is recommended to simplify file verification by external tools, but is not required.

Field descriptions

The header row with field names is not used during import (it can be omitted) — the order of the fields is crucial.

Mandatory fields are marked with a (warning) icon.

Fields that can be left blank for simplicity are marked with a (green star) icon.

Number

Name

Description

1

(green star) External identifier

Unique equipment identifier. Not used in the current version.

2

(warning) Equipment type

Equipment type code in Hydra, usually it's a model of device. In Hydra: Master Data → Product Catalog → Material assets.

For each type, before loading, you need to create a product catalog item and configure its specification (types and number of ports).

3

(warning) Equipment code

Short unique name of a particular device item.

4

(green star) Street address

Equipment location address in the following format: <locality name>,<locality type>,<street name>,<street type>,<building>,<entrance>,<floor>,<apartment>.

  1. Locality name. Region's code in Hydra registry of regions. For example: "San Francisco".
  2. Full or short name of the type of locality. For example: "City", "Town", "Set." or "Settlement".
    (warning) All variants must be configured in Hydra: Master Data → Reference Data → Region types.
    (green star) If not specified, the City type is used by default.
  3. Street name. Region's code in Hydra registry of regions. For example: "Line Wall".
  4. Full or short name of the type of street. For example: "Street" or "St.", "Road" or "Rd.", "Square" or "Sq.".
    (warning) All variants must be configured in Hydra: Master Data → Reference Data → Region types.
    (green star) If not specified, the Street type is used by default.
  5. Building can be represented in two ways:
    • Extended — Bldg. <house> Corpus <pavilion> Annex <structure> Ownership <property>
      (info) Specify only the necessary details of the building, keeping respective abbreviated designations. For example: "Bldg. 25 Annex A".
    • Basic — only the house number (if it starts with a digit) or only the pavilion (if it starts with a letter).
  6. Entrance number.
  7. Floor number, numeric value.
  8. The number of the office, apartment or other premises.

If some details are missing, leave only commas. If the address is not needed at all, leave the field blank.

5

(green star) Non-standard address

The unstructured part of the equipment location address, e.g. "attic" or "third door on the left".

6

(green star) IPv4 address

IPv4 address of the equipment for provisioning or customers AAA (например по IPoE DHCP Option 82) purposes.

7

(green star) VLAN number

VLAN ID of the equipment for provisioning or customers AAA (e.g., via IPoE DHCP Option 82) purposes.

Both basic (e.g., 1234) and double (Q-in-Q) in the format <outer_tag>:<iner_tag> (e.g., 123:321) are supported.

8

(green star) Management type

Name of the management type, e.g. "SSH", "SNMP v2c", or "Telnet".

In Hydra: Master Data → Reference Data → Authorization/Control methods.

9

(green star) Management login

Login (username) for provisioning, for example via SSH.

10

(green star) Management password

Password for provisioning via SSH and Telnet, or community string for SNMP.

11

(warning) Status

Equipment status, for example: Active (in operation), Inactive (not installed yet), Deregistered (decommissioned).

In Hydra: Master Data → Reference Data → Object statuses.

12

(green star) Serial number

Hardware serial number.

13(green star) MAC address

Equipment hardware address for provisioning or customers AAA (e.g. DHCP Option 82 Remote ID) purposes in the format of XX-XX-XX-XX-XX-XX or XX:XX:XX:XX:XX:XX.

Must be individual (unicast).

14(green star) Street address remarkBrief comment on the location of this equipment.
15(green star) Equipment remarkBrief comment on this piece of equipment. 
16(green star) Equipment name

Full name of a particular device item.

17(green star) Management port number

TCP/UDP port for equipment management, numeric value.

Example

ID;TypeCode;Code;StreetAddress;CustomStreetAddress;ManagementIPv4;VLAN;ManagementType;ManagementLogin;ManagementPassword;Status;SerialNumber;MAC;StreetAddressRemark;Remark;Name;ManagementPortNumber
123;Edge-Core ES3528M;SW-Edge.Core.ES3528M-123;London,City,Baker,Street,221B,2,,;attic;128.66.125.125;123:321;SSH;admin;secret;Active;F567G78;00-00-5E-11-22-33;Hotel, the keys are at the reception;The UPS operating time is about 2 hours;Switch Edge-Core ES3528M #123;2022
321;DES1024D;SW-DES1024D-321;;;;;;;;Deregistered;;;;Taken off the network on 31.12.2023;;
  • No labels