Install & upgrade guideAKIPS Release 20.10

© 2020 AKIPS Holdings Pty Ltd

All rights reserved worldwide. No part of this document may be reproduced by any means, nor modified, decompiled, dissembled, published or distributed, in whole or in part, or translated to any electronic medium or other means, without the written consent of AKIPS Holdings Pty Ltd. All rights, title and interest in and to the software documentation are and shall remain the exclusive property of AKIPS and its licensors.

All other trademarks contained in this document are the property of their respective owners.

Disclaimer 

AKIPS disclaims all warranties, conditions or other terms, expressed or implied, statutory or otherwise, on software or documentation furnished hereunder including, without limitation, the warranties of design, merchantability or fitness for a particular purpose and non-infringement. In no event shall AKIPS, its suppliers or its licensors be liable for any damages, whether arising in TOR contract or any other legal theory, even if AKIPS has been advised of the possibility of such damages.

Publisher

AKIPS, PO Box 3422, Shailer Park, Queensland, 4128, Australia

Email: info@akips.com

Website: https://www.akips.com

Edition Software release Date

7 20.10 July 2020

2

Contents

1 Abbreviations 5

2 About this guide 7

2.1 Conventions used in this guide 7

2.1.1 Text  7

2.1.2 Syntax  8

2.1.3 Notes, tips & cautions 9

3 Platform requirements 10

3.1 VM 10

3.1.1 CPU 10

3.1.2 Storage 11

3.1.3 VMware 11

3.1.4 Extending the virtual disk size 11

3.2 Physical hardware 12

4 Downloading & installing AKIPS 13

4.1 Downloading  13

4.2 Installing  13

5 Discovering your network 16

6 Additional configurations 17

6.1 Syslog 17

6.2 SNMP traps 17

6.3 NetFlow 18

3

7 AKIPS licence 19

7.1 Requesting a licence 19

7.2 Activating a licence 19

8 Upgrading AKIPS 20

8.1 Prior to upgrading 20

8.1.1 Identifying your version 20

8.1.2 Options 20

8.1.3 Licence agreement 20

8.2 Upgrading 21

8.3 Installing & upgrading 22

9 Training 23

10 Index 24

4

AbbreviationsThe following is a list of abbreviations used throughout AKIPS's training manuals, including this document.

3DES triple data encryption standard

ADB AKIPS databaseAES advanced encryption standard AKIPS Always Keep It Purely Simple :)API application programming interfaceARP address resolution protocolAS autonomous system

BGP border gateway protocol

CA certificate authority

CBQoS class-based quality of serviceCGI computer gateway interfaceCLI command line interfaceCPU central processing unitCSR certificate signing requestCSV comma-separated valuescURL data encryption standard

DHCP dynamic host configuration protocolDN distinguished nameDNS domain name system

FQDN fully qualified domain name

GB gigabyte

GRE generic routing encapsulationGUI graphical user interface

HTTP hypertext transfer protocolHTTPS hypertext transfer protocol secure

IP internet protocolIPFIX internet protocol flow information exportIPSLA internet protocol service level agreementIS-IS intermediate system to intermediate system

LAN local area networkLDAP lightweight directory access protocol

MAC media access controlMIB management information base

5

1

NAS network-attached storageNDP neighbour discovery protocolNIC network interface cardNTP network time protocol

OID object identifierOS operating system

PCRE Perl-compatible regular expressionsPFX personal information exchange formatPKCS public key cryptography standardsPOSIX portable operating system interfacePSSH parallel secure shell

QoS quality of service

RADIUS remote authentication dial-in user serviceRAM random-access memoryRTT round-trip time

SAN storage area networkSCSI small computer system interfaceSHA secure hash algorithmSMTP simple mail transfer protocolSNMP simple network management protocolSSH secure shellSSL secure sockets layerSTARTTLS start transport layer security

TACACS+ terminal access controller access-control system plusTCP transmission control protocolTLS transport layer securityTOS type of service

UDP user datagram protocolUTC coordinated universal time

VLAN virtual local area networkVM virtual machine

WAN wide area network

6

About this guide

This guide assists users to download, install and upgrade AKIPS Network Monitoring Software.

Conventions used in this guide 

Text  

• Menu names, menu options and field names are shown in bold, e.g. Go to Admin > System > System Settings

• Websites and email addresses are shown in blue, e.g. https://www.akips.com

• Code is shown in monospace

Further:

– command syntax is shown in red, e.g.

{ddd} {hh:mm} to {hh:mm}

– input (user) is shown in blue, e.g.

tf dump last7d

– output (AKIPS) is shown in cyan, e.g.

cisco-74-1-1 sys ip4addr = 10.74.1.1

77

2

2.1

2.1.1

Syntax

Command syntax and variables are formatted as follows:

• command keywords are typed exactly as they appear in the API syntax

• parameters (fields expecting a substituted value) are contained within braces, e.g.

{type} {value}

• optional parameters are contained within square brackets, e.g.

[index,{description}]

• optional parameters may be nested, e.g.

mlist {type} [{parent regex} [{child regex}

[{attribute regex}]]]

• for values separated by a | (pipe), choose one option only, e.g.

[any|all|not group {group name} ...]

• multiple parameters will have ellipses, e.g.

not group {group name} ...

Throughout this document, syntax may be formatted across multiple lines for instructional purposes only. You will need to run commands in a single line.

8

2.1.2

Notes, tips & cautions 

The following icons identify key information:

Note

Necessary information to ensure a successful outcome.

Tip

Useful information to help you to optimise performance or avoid pitfalls.

Caution

Vital information necessary to avoid the risk of data loss or damage.

9

2.1.3

Platform requirementsBefore installing AKIPS, ensure that you meet the minimum requirements:

Interfaces Minimum requirements

Up to 100,000 VM2+ CPU cores8 GB RAM200 GB disk space

100,000 VMto 250,000 4+ CPU cores

16 GB RAM500 GB disk space

250,000+ VM 8+ CPU cores 32 GB RAM1 TB disk space

VMAKIPS is engineered to scale within a VM environment.

The majority of AKIPS's deployments run on VMs; deployment on physical hardware is rare.

CPU

AKIPS requires dedicated CPUs.

CPU cores which are shared between VMs on a VM host will lead to CPU resource starvation. This typically presents itself in AKIPS as jumps in time, gaps in polling and false device-outage reports.

10

3

3.1

3.1.1

Storage

AKIPS requires:

• preallocated/thick provisioning, not thin provisioning

• eager zeroed, not lazy zeroed.

AKIPS runs a real-time database. Its performance depends on sequential read/write performance and expects minimal storage fragmentation and latency.

VMware

When configuring a VMware guest:

• use an emulated LSI SCSI controller

• lock the MAC address to the VM.

Extending the virtual disk size

To extend the size of a virtual disk:

Shut down the VM.

Extend the size of the current virtual disk.

Restart the VM.

The AKIPS startup script will automatically extend the partition/file system as required.

11

3.1.2

3.1.3

3.1.4

Physical hardwareAKIPS recommends installing and evaluating the software in a VM environment before investing in any physical hardware.

All network environments are different and a one-size-fits-all hardware specification will not apply.

AKIPS monitors 1,000,000+ interfaces without specialised hardware. However, it may require a dedicated disk system instead of a SAN or NAS.

AKIPS runs on a FreeBSD OS, so your physical hardware must be compatible.

12

3.2

Downloading & installing AKIPS

Downloading

To download AKIPS:

Go to https://www.akips.com

Select Download from the menu bar.

Click Download.

Read the AKIPS Software Licence Agreement.

Click Install & Upgrade ISO.

Installing

To install AKIPS:

At the AKIPS Network Monitor screen, click Enter.

Click Yes.

At the RISK OF DATA LOSS screen, click Enter.

At the Keymap Selection screen, click Enter to select the default, or scroll to select your preference.

At the Set Hostname screen, type a valid hostname.domain

Click Enter.

Do not use an invalid domain name such as .home, .local or .test

13

4

4.1

4.2

AKIPS will check and extract the OS files after a short delay.

When prompted, enter a password for the admin user.

Click Enter.

This password is used for the root, akips and admin accounts. If you later require shell access, log in as the akips user with this password.

At the Network Configuration screen, select a network interface.

Click Enter.

At the IPv4 Configuration screen, click Enter.

At the Network Configuration DHCP prompt, select No.

Click Enter.

At the Network Configuration (Static Network Interface) screen, complete the following fields:

• IP address

• subnet mask

• default router.

Select OK.

Click Enter.

At the IPv6 Configuration screen, select No.

Click Enter.

You can configure IPv6 later, if required, by going to Admin > System Settings and completing the IPv6 details.

At the Network Configuration (Resolver Configuration) screen, complete the DNS addresses.

14

Select OK.

Click Enter.

At the Network Time Protocol screen, complete an NTP server address.

Click Enter.

Review the Verify Hardware Clock screen:

Scenario Action

Installation on physical Stop the installation and contact your hardware: the displayed system administrator date is incorrect

Installation on a VM: Contact your VM administrator to the displayed date fix the date and time on the VM host is incorrect

The current local Select Yestime displays

The current UTC Select Notime displays

A timezone other than Select Yeslocal or UTC displays

In the following screens, select your applicable timezone options.

Click Enter.

The AKIPS Network Monitor Installer will finish installing.

Click Enter to reboot the server.

A number of steps will take place as part of the reboot, which will not require any action from you.

When the installation has finished, a login prompt will display.

15

Discovering your networkTo discover all of the SNMP-capable devices in your network, AKIPS will perform a scan based on IP address ranges and SNMP parameters.

To discover your network:

Log into AKIPS as your admin user.

Go to Admin > Discover > Discover / Rewalk.

Complete the Discover / Rewalk panel, using the guidance on the right-hand side.

Ensure that 2. Ping Scan Ranges and 3. SNMP Parameters are complete and accurate.

Click Save Changes.

Select Discover to perform a scan of your network.

Typically, a discover will take several minutes.

As the scan executes, AKIPS will list the discovered devices.

When the discover has finished, a message will display in green.

To verify that AKIPS is working:

Wait five minutes after the discover has finished.

Check both:

• Reports > Device > IPv4 Ping Statistics

• Reports > Interface > Statistics.

If the tables populate with data, then AKIPS is working.

16

5

Additional configurations

SyslogYou can configure routers and switches to send syslog messages to the AKIPS server.

Consult your equipment vendor’s documentation for information on sending syslogs to AKIPS (as a syslog collector).

To check the syslog: 

Go to Tools > Syslog.

Select either Table or Top Talkers to view.

SNMP trapsAKIPS supports the decoding of SNMPv2 and SNMPv3 traps.

It does not support SNMPv1 traps.

To set up SNMP traps:

Go to Admin > General > SNMP Traps.

Complete the SNMP trap parameters, using the guidance on the right-hand side.

Click Save.

Go to Tools > SNMP Traps.

Select either Table or Top Talkers to view.

6

6.1

6.2

17

6.3 NetFlowYou can configure routers to send NetFlow messages to AKIPS on ports 2055, 4739, 9995 or 9996.

AKIPS supports NetFlow versions 5* and 9, Netstream, J-Flow versions 5 and 9, and IPFIX. (*Although AKIPS supports NetFlow v5, it doesn't support index numbers or AS numbers for this protocol. We therefore recommend that you use v9.)

To display NetFlow reports:

Go to Tools > NetFlow.

Define your report using the NetFlow Reporter parameters.

Select one of the following options:

• Table

• Bar Graph

• Disk Usage

• Unknown Ports.

If the routers are correctly configured, the report will display.

18

7

7.1

7.2

AKIPS licenceTo access all of AKIPS's features, you will need to activate a licence.

Requesting a licence

To request a licence:

Go to https://www.akips.com

Select Download from the menu bar.

Click Request Evaluation Key.

Complete all mandatory fields.

Select Request a Trial Key.

A message will confirm that the AKIPS team is processing your request.

Activating a licence

To activate your licence:

Copy the licence key emailed to you by AKIPS.

Go to Admin > System > Activation.

Paste the key into the Licence Key field.

Click Activate Licence.

The page will refresh to show that the licence has been activated, with the expiry details.

The AKIPS homepage will refresh with your licence details.

You will now have a full copy of AKIPS.

19

8

8.1

8.1.1

8.1.2

8.1.3

20

Upgrading AKIPS

Prior to upgrading

Identifying your version

You can view your version number in the top-right corner of AKIPS.

AKIPS recommends that you regularly upgrade to the latest version.

After you have downloaded the file, upgrading AKIPS is quick, often taking less than a minute.

Options

Depending on the release requirements, one of the following upgrade options will be available:

• upgrading ONLY the AKIPS software (Upgrade ISO)

• upgrading BOTH the OS and AKIPS software (Install and Upgrade ISO).

Licence agreement

To accept the licence agreement:

Go to https://www.akips.com

Select Download from the menu bar.

Read the terms outlined in the Licence Agreement.

Proceed with the download only if you agree to the terms.

8.2

By downloading the AKIPS software, you are bound to the terms of the licence agreement.

Upgrading

To upgrade only the AKIPS software:

Select Download.

Click Upgrade ISO.

Save the file onto your computer.

The software will download, displaying the version number in the filename, e.g. akips-19.1-upgrade.iso

Log in to AKIPS as your admin user.

Go to Admin > System > Update.

Select Browse to locate the downloaded file.

Click Open.

At the Software Update screen, select Start Upgrade.

Depending on your browser, either the percentage uploaded will display in the progress bar, or a spinning icon will display.

After the upload has completed, the Software Update will automatically start.

When the update has finished, AKIPS will update the version details on the menu bar and resume monitoring your network.

21

8.3 Installing & upgrading

To upgrade both the OS & AKIPS software:

Select Download.

Click Install & Upgrade ISO.

Save the file onto your computer.

The software will download, displaying the version number in the filename, e.g. akips-19.1-upgrade.iso

Log in to AKIPS as your admin user.

Go to Admin > System > Update.

Select Browse to locate the downloaded file.

Click Open.

At the Software Update screen, select Start Upgrade.

Depending on your browser, either the percentage uploaded will display in the progress bar, or a spinning icon will display.

After the upload has completed, the Software Update will automatically start.

When the update has finished, AKIPS will reboot your OS.

Refresh your browser to access AKIPS.

AKIPS will update the version details on the menu bar and resume monitoring your network.

22

9 TrainingTo fully learn how to use AKIPS, you can register for training.

AKIPS's training partner, Klarity, caters to users in both hemispheres.

Training provides timesaving guidance and tips, including for:

• grouping

• alerting

• site scripts/integration

• config crawler.

23

10 IndexSection Section Page

number number

Activating a licence 7.2 19Additional configurations 6 17AKIPS licence 7 19

CPU (Platform requirements) 3.1.1 10

Discovering your network 5 16Downloading 4.1 13 & installing AKIPS 4 13

Extending the virtual disk size VM (Platform requirements) 3.1.4 11

hardware, Physical 3.2 12

Identifying your version (Upgrading AKIPS) 8.1.1 20Installing 4.2 13 & upgrading 8.3 22

licence Activating a 7.2 19 agreement (Upgrading AKIPS) 8.1.3 20 Requesting a 7.1 19

NetFlow (Additional configurations) 6.3 18

Options (Upgrading AKIPS) 8.1.2 20

Physical hardware 3.2 12Platform requirements 3 10Prior to upgrading 8.1 20

Requesting a licence 7.1 19

SNMP traps (Additional configurations) 6.2 17Storage (Platform requirements) 3.1.2 11Syslog (Additional configurations) 6.1 17

Training 9 23

Upgrading 8.2 21 AKIPS 8 20 Prior to 8.1 20

VM (Platform requirements) 3.1 10 Storage (Platform requirements) 3.1.2 11VMware (Platform requirements) 3.1.3 11

24