Skip to main content

Outscale API

Pack Assets​

Templates​

The Centreon Monitoring Connector Outscale brings a host template:

  • Cloud-Outscale-Osscli-custom

It brings the following service templates:

Service AliasService TemplateService DescriptionDefaultDiscovery
Account-ConsumptionsCloud-Outscale-Account-Consumptions-OsccliCheck the consumption of your accountX
Client-GatewaysCloud-Outscale-Client-Gateways-OsccliCheck client gatewaysX
Internet-ServicesCloud-Outscale-Internet-Services-OsccliCheck internet servicesX
Load-BalancersCloud-Outscale-Load-Balancers-OsccliCheck load balancersX
Nat-ServicesCloud-Outscale-Nat-Services-OsccliCheck NAT servicesX
NetsCloud-Outscale-Nets-OsccliCheck NetsX
QuotasCloud-Outscale-Quotas-OsccliCheck quotasX
Route-TablesCloud-Outscale-Route-Tables-OsccliCheck route tablesX
SubnetsCloud-Outscale-Subnets-OsccliCheck subnetsX
Virtual-GatewaysCloud-Outscale-Virtual-Gateways-OsccliCheck virtual gatewaysX
VmsCloud-Outscale-Vms-OsccliCheck virtual machinesX
VolumesCloud-Outscale-Volumes-OsccliCheck volumesX
Vpn-ConnectionsCloud-Outscale-Vpn-Connections-OsccliCheck VPN connectionsX

Discovery rules​

Rule NameDescription
Cloud-Outscale-Osccli-Client-Gateway-NameDiscover client gateways and monitor status
Cloud-Outscale-Osccli-Internet-Service-NameDiscover internet services and monitor status
Cloud-Outscale-Osccli-Load-Balancer-NameDiscover load balancers and monitor status
Cloud-Outscale-Osccli-Nat-Service-NameDiscover NAT services and monitor status
Cloud-Outscale-Osccli-Net-NameDiscover Nets and monitor status
Cloud-Outscale-Osccli-Quota-Type-NameDiscover quotas and monitor status
Cloud-Outscale-Osccli-Route-Table-IdDiscover route tables and monitor status
Cloud-Outscale-Osccli-Subnet-NameDiscover subnets and monitor status
Cloud-Outscale-Osccli-Virtual-Gateway-NameDiscover virtual gateways and monitor status
Cloud-Outscale-Osccli-Vm-NameDiscover virtual machines and monitor status
Cloud-Outscale-Osccli-Volume-IdDiscover volumes and monitor status
Cloud-Outscale-Osccli-Vpn-Connection-NameDiscover VPN connections and monitor status

More information about discovering services automatically is available on the dedicated page and in the following chapter.

Collected metrics & status​

Metric NameUnit
account.consumptions.detected.count
title~service~region#accounts.consumption.count

Prerequisites​

Please follow the official documentation to install osc-cli for the user centreon-engine: https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html

A user Outscale with the following privileges should be used:

    "Statement": [
        {
            "Action": [
                "*:Describe*",   ç Les droits sont bien positionnés…
                "*:Read*"
            ],
            "Resource": "*",
            "Effect": "Allow"
        }
    ]

Setup​

Monitoring Pack​

If the platform uses an online license, you can skip the package installation instruction below as it is not required to have the pack displayed within the Configuration > Monitoring Connector Manager menu. If the platform uses an offline license, install the package on the central server with the command corresponding to the operating system's package manager:

dnf install centreon-pack-cloud-outscale

Whatever the license type (online or offline), install the Outscale Pack through the Configuration > Monitoring Connector Manager menu.

Plugin​

Since Centreon 22.04, you can benefit from the 'Automatic plugin installation' feature. When this feature is enabled, you can skip the installation part below.

You still have to manually install the plugin on the poller(s) when:

  • Automatic plugin installation is turned off
  • You want to run a discovery job from a poller that doesn't monitor any resource of this kind yet

More information in the Installing the plugin section.

Use the commands below according to your operating system's package manager:

dnf install centreon-plugin-Cloud-Outscale-Api

Configuration​

Host​

  • Log into Centreon and add a new host through Configuration > Hosts.
  • Fill the Name, Alias & IP Address/DNS fields according to your Outscale server settings.
  • Apply the Cloud-Outscale-Osscli-custom template to the host.
  • Once the template is applied, fill in the corresponding macros. Some macros are mandatory.
MandatoryMacroDescription
OUTSCALEEXTRAOPTIONSAny extra option you may want to add to every command line (eg. a --verbose flag)
OUTSCALEPROFILEosc-cli profile
OUTSCALEVIRTUALENVPython virtual environment for osc-cli (ex: /var/lib/centreon-engine/.venv)
PROXYURL

How to check in the CLI that the configuration is OK and what are the main options for?​

Once the plugin is installed, log into your Centreon poller's CLI using the centreon-engine user account (su - centreon-engine) and test the plugin by running the following command:

/usr/lib/centreon/plugins/centreon_outscale_api.pl \
    --plugin=cloud::outscale::plugin \
    --mode=quotas \
    --custommode='osccli' \
    --profile='default' \
    --virtual-env='/var/lib/centreon-engine/.venv' \
    --filter-name='^networklink_limit$' \
    --filter-type='^vpc-42484aa9$' \
    --verbose

The expected command output is shown below:

OK: quota 'networklink_limit' [type: vpc-42484aa9] total: 75 used: 1 (1.33%) free: 74 (98.67%) | 'vpc-42484aa9~networklink_limit#quota.usage.count'=1;;;0;75 'vpc-42484aa9~networklink_limit#license.free.count'=74;;;0;75 'vpc-42484aa9~networklink_limit#license.usage.percentage'=1.33%;;;0;100

All available options for a given mode can be displayed by adding the --help parameter to the command:

/usr/lib/centreon/plugins/centreon_outscale_api.pl \
    --plugin=cloud::outscale::plugin \
    --mode=quotas \
    --help

All available modes can be displayed by adding the --list-mode parameter to the command:

/usr/lib/centreon/plugins/centreon_outscale_api.pl \
    --plugin=cloud::outscale::plugin \
    --list-mode

Troubleshooting​

Please find the troubleshooting documentation for Centreon Plugins typical issues.