Function: colocation
Result: the list of elements
Colocation
Access level: admin user
- id — Id
- pricelist — Tariff plan
- account — Client
- project — Provider
- datacentername — Data center
- processingmodule — Processing module
- createdate — Creation date
- expiredate — End date
- autoprolong — Auto renewal
- status_msg — Status
- item_status — Status
- cost — Price
Suspend
Function: colocation.suspend
Suspend
Access level: admin
Parameters:
- elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of colocation function.
Result: successful operation or error message
Edit properties of the selected service
Function: colocation.edit
Access level: admin user
The function is simultaneously used to view object's parameters, to change an object, and create new one.
View object's parameters:
- Parameters:
- elid — unique identifier (id element of colocation function)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- panelid — identifier in the control panel
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (id element of colocation function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- processingmodule — Processing module. Processing module
- autoprolong — Auto renewal. Select a period to automatically renew the service upon expiration
- createdate — Order date . Date when the service was ordered
- opendate — Creation date. Activation date
- expiredate — Expiration date. Validity period
- scheduledclose — . (Optional parameter. To enable the option click "on".) Service will be deleted after paid period
- reboot — . (Optional parameter. To enable the option click "on".) Reboot server to apply changes
- note — Comment. Enter any information related to the service. It will be displayed only to administrators
- noexpense — . (Optional parameter. To enable the option click "on".) Select the check box if you don't want to charge/refund a client if his service resources have been changed
Set filter.
colocation.filter
Resume
Function: colocation.resume
Resume
Access level: admin
Parameters:
- elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of colocation function.
Result: successful operation or error message
Set a filter by the selected client
Function: colocation.setfilter
Set a filter by the selected client
Access level: admin
Name
Function: colocation.hardware
Result: the list of elements
Hardware
Access level: admin user
- id — Id
- hardware — Description
- receivingdate — Date
- returndate — Return date
- status — Status
Return of equipment
Function: colocation.hardware.return
Access level: admin
The function is simultaneously used to view object's parameters, to change an object, and create new one.
View object's parameters:
- Parameters:
- plid — parent list unique identifier (id element of colocation function).
- elid — unique identifier (id element of colocation.hardware function)
- Result: object parameters list
Create an object:
Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (id element of colocation function).
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (id element of colocation function).
- elid — unique identifier (id element of colocation.hardware function)
- additional query parameters ...
- Result: successfull operation or error message
The list object's parameters or additional query parameters (see above):
- returnemployee — Delivered. Full name of a staff member who delivered equipment to client
- returnuser — Accepted. Full name of a staff member who accepted equipment
- returndate — Return date. Date when equipment was returned to client
Certificate that confirms return of equipment to client
Function: colocation.hardware.return_print
Certificate that confirms return of equipment to client
Access level: admin
Acceptance of equipment by provider
Function: colocation.hardware.receiving_print
Acceptance of equipment by provider
Access level: admin
Equipment parameters
Function: colocation.hardware.edit
Access level: admin
The function is simultaneously used to view object's parameters, to change an object, and create new one.
View object's parameters:
- Parameters:
- plid — parent list unique identifier (id element of colocation function).
- elid — unique identifier (id element of colocation.hardware function)
- Result: object parameters list
Create an object:
Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (id element of colocation function).
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (id element of colocation function).
- elid — unique identifier (id element of colocation.hardware function)
- additional query parameters ...
- Result: successfull operation or error message
The list object's parameters or additional query parameters (see above):
- unit — Colocation . Colocation (rack and unit number)
- hardware — Description . Equipment description
- note — Comment. Add your comment
- receiveemployee — Accepted . Full name of a staff member who accepted equipment
- receiveuser — Delivered . Full name of the client who delivered equipment
- receivingdate — Date . Date when equipment was accepted by provider
- returnemployee — Delivered . Full name of a staff member who delivered equipment
- returnuser — Accepted . Full name of the client who accepted equipment
- returndate — Return date . Date when equipment was returned to client
Delete
Function: colocation.hardware.delete
Delete
Access level: admin
Parameters:
- elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of colocation.hardware function.
Result: successful operation or error message
Drill down to User panel
Function: colocation.su
Drill down to User panel
Access level: admin
Service activation
Function: colocation.open
Access level: admin
The function is simultaneously used to view object's parameters, to change an object, and create new one.
View object's parameters:
- Parameters:
- elid — unique identifier (id element of colocation function)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (id element of colocation function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- processingmodule — Processing module. Processing module for this service
Name
Function: colocation.port
Result: the list of elements
Network connections
Access level: admin user
- id — Id
- name — Name
- linked_port — Linked port
- vlan — Virtual network
Network connection
Function: colocation.port.edit
Access level: admin
The function is simultaneously used to view object's parameters, to change an object, and create new one.
View object's parameters:
- Parameters:
- plid — parent list unique identifier (id element of colocation function).
- elid — unique identifier (id element of colocation.port function)
- Result: object parameters list
Create an object:
Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (id element of colocation function).
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (id element of colocation function).
- elid — unique identifier (id element of colocation.port function)
- additional query parameters ...
- Result: successfull operation or error message
The list object's parameters or additional query parameters (see above):
- type — Connection type . Select a connection type
- linked_port — Linked port . Select a linked port
- note — Comment. Add your comment
Delete
Function: colocation.port.delete
Delete
Access level: admin
Parameters:
- elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of colocation.port function.
Result: successful operation or error message
Delete the selected services
Function: colocation.delete
Delete the selected services
Access level: admin user
Parameters:
- elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of colocation function.
Result: successful operation or error message
Order a new service
Function: colocation.order
Order a new service
Access level: user