Consulta
La API REST de Servicios CGES permite la consulta de todos los recursos de infraestructura (hardware) que pueden ser gestionados por el proveedor que realiza la llamada.
Los filtros disponibles y la información extraída en el listado son únicos para todos los usuarios de la API.
El parámetro uuid que devuelve el listado será el utilizado para realizar el resto de las operaciones con cada uno de los recursos contenidos en el mismo.
También será posible el empleo del parámetro codigo para la consulta segmentada de subconjuntos predefinidos para el total de recursos de infraestructura.
Los recursos de infraestructura pertenecen a un tipo concreto, y a su vez, estos tipos están agrupados en familias.
Estas son las familias que conforman el conjunto de recursos de infraestructura y que pueden gestionarse (dependiendo el perfil del proveedor) desde este apartado de la API:
- Familia Hardware: Comprende equipos y elementos de hardware como monitores, impresoras, puestos de trabajo, servidores, etc.
- Hardware.Puesto de Trabajo
- Hardware.Impresoras
- Hardware.Monitor
- Hardware.Servidor
- ...
- Familia Redes: Comprende elementos vinculados a comunicaciones como líneas, routers, switches, etc.
- Redes.Electrónica de Red
- Redes.Servicio de Datos
- Redes.Otros
Es posible consultar las familias y tipos disponibles en los siguientes métodos de tablas maestras de la API:
Para obtener más información acerca de un recurso de infraestructura se puede consultar el método destinado a tal fin en la API.
Este método devuelve información detallada del recurso de hardware como, por ejemplo, el número de serie, código SAS, la marca, el modelo, la ubicación, el estado y otros datos de interés.
La capacidad de consulta es análoga a la capacidad de gestión en los listados.
Además, en función de la familia y el tipo del recurso, podrá consultar algunos enlaces extendidos para extraer otra información adicional (ver apartados siguientes).
Creación y edición
Es posible realizar la creación de un recurso mediante el siguiente método:
Requisitos funcionales
Debe enviarse siempre la estructura de datos completa del recurso. En caso de elementos opcionales, enviar null.
- El nombre es obligatorio y debe tener un máximo de 100 caracteres.
- El tipo es obligatorio y debe ser un tipo válido y permitido para el proveedor.
- El número de serie es obligatorio y no debe existir en el sistema. Máximo 64 caracteres.
El código SAS es opcional y debe cumplir con un formato válido (6/7 cifras y una letra).
Los valores de IP y MAC son opcionales, deben tener un máximo de 64 caracteres y cumplir con formatos válidos.
- La criticidad es obigatoria y debe ser válida.
- Los parámetros de ubicación física (planta, sala, rack y toma de red) deben tener un máximo de 30 caracteres y son opcionales.
- El departamento organizativo es opcional y debe ser una organización válida en caso de informarse.
- La ubicación del recurso debe ser válida y es obligatoria.
- El modelo debe ser válido (únicamente opcional para líneas y direccionamientos).
- El contacto asignado es opcional y debe ser válido en caso de informarse.
Dependencias para el expediente de compra:
- Máquinas virtuales: Este tipo de recursos no debe tener asociado expediente de compra. En caso de enviar uno, se ignorará.
- Tampoco se permite expediente de compra para elementos de provisión de datos: Router Principal, Router Respaldo, Línea Principal, Línea Backup y Direccionamiento.
- El resto de recursos de Hardware requieren un expediente de forma obligatoria.
- El resto de recursos de Redes requieren un expediente de forma obligatoria.
En caso de querer registrar información adicional de puestos de trabajo o redes durante la creación, deberá lanzar primero este método y luego actualizar estos valores con los métodos disponibles (ver apartados posteriores).
¡Importante!
Para realizar correctamente la modificación se debe enviar el objeto completo cada vez que se consuma este recurso.
En caso de no enviar alguno de los valores, el recurso borrará la información para los atributos no informados.
Requisitos funcionales comunes
El recurso debe ser gestionable por el proveedor (visualizable en su listado)
Debe cumplir con los requerimientos de obligatoriedad y formato expresados en la creación.
- El número de serie no es modificable.
Existen tres versiones diferentes para la modificación de recursos de infraestructura:
- v1.0 - Modificar recurso de infraestructura: Permite modificar al completo un recurso.
Requisitos funcionales
Debe enviarse siempre la información completa del recurso al editar.
- Es obligatorio enviar el estado y debe ser válido.
- En caso de cambiar el estado, el cambio debe estar permitido dentro de la matriz de estados de recursos.
- Sólo se puede modificar el tipo dentro de una misma familia.
- Los recursos federados por ALTIRIS (cuentan con MDR de ALTIRIS asociado) tendrán limitada la edición a los siguientes campos: planta, sala, rack, toma de red, departamento organizativo y/o contacto asignado.
- v2.0 - Modificar información de contratos para un recurso de infraestructura (de uso reservado para coordinadores de mantenimiento de hardware).
Información adicional
Para consultar los MDR asociados al recurso y crear nuevos vínculos, se puede hacer uso del siguiente conjunto de métodos:
Información adicional por familias
Información adicional de puestos de trabajo
Este método permite consultar la información adicional acerca de un recurso de la familia "Hardware.Puesto de trabajo"
Información adicional de redes
Este método permite consultar la información adicional acerca de un recurso de las familias de "Redes"
Información adicional de máquinas virtuales
Este método permite consultar la información adicional acerca de un recurso de la familia "Hardware.Maquina Virtual"
Información adicional de servidores
Este método permite consultar la información adicional acerca de un recurso de la familia "Hardware.Servidor"
También es posible modificar la información extendida de los recursos, empleado los siguientes métodos:
Actualizar información adicional de puestos de trabajo
El siguiente método permite actualizar la información adicionar de un recurso de la familia "Hardware.Puesto de trabajo".
¡Importante!
Para realizar correctamente la modificación se debe enviar el objeto completo cada vez que se consuma este recurso.
En caso de no enviar alguno de los valores, el recurso borrará la información para los atributos no informados.
Requisitos funcionales
El recurso debe ser gestionable por el proveedor (visualizable en su listado)
Todos los campos son opcionales.
- La memoria RAM admite un máximo de 15 caracteres.
- La capacidad de disco admite un máximo de 15 caracteres.
- El número de serie de la placa base admite un máximo de 50 caracteres.
- El sistema operativo debe ser válido.
- El tipo de procesador admite un máximo de 15 caracteres.
- La velocidad del procesador admite un máximo de 15 caracteres.
Actualizar información adicional de redes
El siguiente método permite actualizar la información adicional acerca de un recurso de las familias de "Redes".
¡Importante!
Para realizar correctamente la modificación se debe enviar el objeto completo cada vez que se consuma este recurso.
En caso de no enviar alguno de los valores, el recurso borrará la información para los atributos no informados.
Requisitos funcionales
El recurso debe ser gestionable por el proveedor (visualizable en su listado)
Todos los campos son opcionales.
- El nombre de red admite un máximo de 50 caracteres.
- La IP de gestión admite un máximo de 50 caracteres.
- La máscara de subred admite un máximo de 50 caracteres.
- La tecnología admite un máximo de 50 caracteres.
- El protocolo admite un máximo de 15 caracteres.
- El flujo admite un máximo de 50 caracteres.
Entidades asociadas
Contratos
El siguiente método permite obtener los contratos vinculados a un recurso de infraestructura.
Entidades asociadas para provisión de datos
Relaciones entre líneas y routers
Se puede crear y eliminar vínculos entre líneas y routers mediante el uso de los siguientes métodos:
Requisitos funcionales
- La relación entre líneas y routers es única, no pudiendo existir más de un vinculo para una misma línea o router.
- Sólo se pueden vincular recursos de estos tipos, sin ser posible realizar vinculaciones cruzadas entre elementos principales y de respaldo:
- "Linea Principal" con "Router Principal".
- "Linea Backup" con "Router Respaldo".