SoftLayer.metadata

Metadata Manager/helpers

license:MIT, see LICENSE for more details.
class SoftLayer.managers.metadata.MetadataManager(client=None, timeout=5)[source]

Provides an interface for the SoftLayer metadata service.

See product information here: http://sldn.softlayer.com/reference/services/SoftLayer_Resource_Metadata

This provides metadata about the resourse it is called from. See METADATA_ATTRIBUTES for full list of attributes.

Usage:

>>> import SoftLayer
>>> client = SoftLayer.create_client_from_env()
>>> from SoftLayer import MetadataManager
>>> meta = MetadataManager(client)
>>> meta.get('datacenter')
'dal05'
>>> meta.get('fqdn')
'test.example.com'
Parameters:client (SoftLayer.API.BaseClient) – the client instance
get(name, param=None)[source]

Retreive a metadata attribute.

Parameters:
  • name (string) – name of the attribute to retrieve. See attribs
  • param – Required parameter for some attributes
private_network(**kwargs)[source]

Returns details about the private network.

Parameters:
  • router (boolean) – True to return router details
  • vlans (boolean) – True to return vlan details
  • vlan_ids (boolean) – True to return vlan_ids
public_network(**kwargs)[source]

Returns details about the public network.

Parameters:
  • router (boolean) – True to return router details
  • vlans (boolean) – True to return vlan details
  • vlan_ids (boolean) – True to return vlan_ids
metadata.METADATA_ATTRIBUTES = ['datacenter', 'domain', 'backend_mac', 'primary_ip', 'primary_backend_ip', 'tags', 'primary_frontend_ip', 'hostname', 'fqdn', 'user_data', 'datacenter_id', 'vlan_ids', 'frontend_mac', 'user_metadata', 'provision_state', 'router', 'vlans', 'id']