Abiquo Documentation Cookies Policy

Our Documentation website uses cookies to improve your experience. Please visit our Cookie Policy page for more information about cookies and how we use them.


Documentation

Skip to end of metadata
Go to start of metadata

Device Types Resource

Contents:

Main URI of the Resource

This class operates mainly over the Resource URI: /config/devicetypes

Exposed Methods

Retrieve all device types

Returns all device types supported by Abiquo.

Synopsis: GET http://example.com/api/config/devicetypes
Roles Required: ROLE_AUTHENTICATED
Request Headers: Accept:  application/vnd.abiquo.devicetypes+json; version=3.8; application/vnd.abiquo.devicetypes+xml; version=3.8;  Content-type: ;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

Request Message Body Entity: 
Response Message Body Entity: DeviceTypesMediaType
Request Example:

 Click here to show or hide the request example
curl -X GET "https://38testing.bcn.abiquo.com/api/config/devicetypes"
{
    "links": [],
    "collection": [
        {
            "links": [
                {
                    "title": "openstack-neutron",
                    "rel": "self",
                    "type": "application/vnd.abiquo.devicetype+json",
                    "href": "https://38testing.bcn.abiquo.com:443/api/config/devicetypes/openstack-neutron"
                }
            ],
            "name": "openstack-neutron",
            "deviceInterfaces": [
                {
                    "deviceInterface": "Vpc",
                    "realName": "OpenStack Neutron VPC",
                    "constraints": {},
                    "operations": {
                        "vpc": {}
                    }
                },
                {
                    "deviceInterface": "Networking",
                    "realName": "OpenStack Neutron Networks",
                    "constraints": {},
                    "operations": {
                        "networking": {}
                    }
                },
                {
                    "deviceInterface": "Firewall",
                    "realName": "OpenStack Neutron Firewall",
                    "constraints": {},
                    "operations": {
                        "firewall": {
                            "modifyFirewallPolicy": []
                        }
                    }
                },
                {
                    "deviceInterface": "LoadBalancers",
                    "realName": "OpenStack Neutron Load Balancer",
                    "constraints": {
                        "loadbalancer_routingrules_protocols_csv": "TCP,HTTP,HTTPS",
                        "loadbalancer_firewall_supported": "true",
                        "loadbalancer_algorithms_csv": "ROUND_ROBIN,LEAST_CONNECTIONS,SOURCE_IP",
                        "loadbalancer_healthcheck_protocols_csv": "PING,TCP,HTTP,HTTPS",
                        "loadbalancer_addressess_reuse": "false"
                    },
                    "operations": {
                        "loadbalancers": {
                            "listSSLCertificates": [],
                            "listVirtualMachinesHealth": []
                        }
                    }
                },
                {
                    "deviceInterface": "DHCP",
                    "realName": "OpenStack Neutron DHCP Configurator",
                    "constraints": {},
                    "operations": {
                        "dhcp": {}
                    }
                }
            ]
        },
        {
            "links": [
                {
                    "title": "nsx",
                    "rel": "self",
                    "type": "application/vnd.abiquo.devicetype+json",
                    "href": "https://38testing.bcn.abiquo.com:443/api/config/devicetypes/nsx"
                }
            ],
            "name": "nsx",
            "deviceInterfaces": [
                {
                    "deviceInterface": "Vpc",
                    "realName": "NSX Vpc",
                    "constraints": {},
                    "operations": {
                        "vpc": {}
                    }
                },
                {
                    "deviceInterface": "Networking",
                    "realName": "NSX Networks",
                    "constraints": {},
                    "operations": {
                        "networking": {
                            "createIpInNetwork": [],
                            "createBulkIpsInNetwork": [],
                            "deleteIpFromNetwork": []
                        }
                    }
                },
                {
                    "deviceInterface": "ExternalNetworking",
                    "realName": "NSX External Networks",
                    "constraints": {},
                    "operations": {
                        "externalnetworking": {
                            "listExternalNetworks": [],
                            "listGlobalNetworks": [],
                            "deleteExternalNetwork": []
                        }
                    }
                },
                {
                    "deviceInterface": "PublicNetworking",
                    "realName": "NSX Public Networks",
                    "constraints": {},
                    "operations": {
                        "publicnetworking": {
                            "deletePublicNetwork": [],
                            "listPublicNetworks": []
                        }
                    }
                },
                {
                    "deviceInterface": "Firewall",
                    "realName": "NSX Firewall",
                    "constraints": {},
                    "operations": {
                        "firewall": {}
                    }
                },
                {
                    "deviceInterface": "LoadBalancers",
                    "realName": "NSX Load Balancers",
                    "constraints": {
                        "loadbalancer_routingrules_protocols_csv": "HTTP,HTTPS,TCP,UDP",
                        "loadbalancer_firewall_supported": "false",
                        "loadbalancer_algorithms_csv": "ROUND_ROBIN,IP_HASH,LEAST_CONN,URI,HTTP_HEADER,URL",
                        "loadbalancer_healthcheck_protocols_csv": "HTTP,HTTPS,TCP,UDP,ICMP",
                        "loadbalancer_addressess_reuse": "false"
                    },
                    "operations": {
                        "loadbalancers": {
                            "addRoutingRules": [],
                            "removeRoutingRules": [],
                            "listVirtualMachinesHealth": []
                        }
                    }
                },
                {
                    "deviceInterface": "DHCP",
                    "realName": "NSX DHCP Configurator",
                    "constraints": {},
                    "operations": {
                        "dhcp": {}
                    }
                }
            ]
        }
    ]
}

Main URI of the Resource

This class operates mainly over the Resource URI: /config/devicetypes/{devicetype}

Exposed Methods

Retrieve a device type

Returns a device type depending on its identifier

Synopsis: GET http://example.com/api/config/devicetypes/{devicetype}
Roles Required: ROLE_AUTHENTICATED
Request Headers: Accept:  application/vnd.abiquo.devicetype+json; version=3.8; application/vnd.abiquo.devicetype+xml; version=3.8;  Content-type: ;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

Request Message Body Entity: 
Response Message Body Entity: DeviceTypeMediaType  
Request Example:

 Click here to show or hide the request example
curl -X GET "https://38testing.bcn.abiquo.com/api/config/devicetypes/nsx"
{
    "links": [
        {
            "title": "nsx",
            "rel": "self",
            "type": "application/vnd.abiquo.devicetype+json",
            "href": "https://38testing.bcn.abiquo.com:443/api/config/devicetypes/nsx"
        }
    ],
    "name": "nsx",
    "deviceInterfaces": [
        {
            "deviceInterface": "Vpc",
            "realName": "NSX Vpc",
            "constraints": {},
            "operations": {
                "vpc": {}
            }
        },
        {
            "deviceInterface": "Networking",
            "realName": "NSX Networks",
            "constraints": {},
            "operations": {
                "networking": {
                    "createIpInNetwork": [],
                    "createBulkIpsInNetwork": [],
                    "deleteIpFromNetwork": []
                }
            }
        },
        {
            "deviceInterface": "ExternalNetworking",
            "realName": "NSX External Networks",
            "constraints": {},
            "operations": {
                "externalnetworking": {
                    "listExternalNetworks": [],
                    "listGlobalNetworks": [],
                    "deleteExternalNetwork": []
                }
            }
        },
        {
            "deviceInterface": "PublicNetworking",
            "realName": "NSX Public Networks",
            "constraints": {},
            "operations": {
                "publicnetworking": {
                    "deletePublicNetwork": [],
                    "listPublicNetworks": []
                }
            }
        },
        {
            "deviceInterface": "Firewall",
            "realName": "NSX Firewall",
            "constraints": {},
            "operations": {
                "firewall": {}
            }
        },
        {
            "deviceInterface": "LoadBalancers",
            "realName": "NSX Load Balancers",
            "constraints": {
                "loadbalancer_routingrules_protocols_csv": "HTTP,HTTPS,TCP,UDP",
                "loadbalancer_firewall_supported": "false",
                "loadbalancer_algorithms_csv": "ROUND_ROBIN,IP_HASH,LEAST_CONN,URI,HTTP_HEADER,URL",
                "loadbalancer_healthcheck_protocols_csv": "HTTP,HTTPS,TCP,UDP,ICMP",
                "loadbalancer_addressess_reuse": "false"
            },
            "operations": {
                "loadbalancers": {
                    "addRoutingRules": [],
                    "removeRoutingRules": [],
                    "listVirtualMachinesHealth": []
                }
            }
        },
        {
            "deviceInterface": "DHCP",
            "realName": "NSX DHCP Configurator",
            "constraints": {},
            "operations": {
                "dhcp": {}
            }
        }
    ]
}
  • No labels