REST API 가이드


Red Hat Virtualization 4.4

Red Hat Virtualization REST Application Programming 인터페이스 사용

Red Hat Virtualization Documentation Team

초록

이 가이드에서는 Red Hat Virtualization Manager Representational State Transfer Application Programming Interface에 대해 설명합니다.
이 안내서는 ovirt-engine-api-model 코드의 문서 주석에서 생성되며 현재 부분적으로 완료된 것입니다. 이 문서의 업데이트된 버전은 새 콘텐츠를 사용할 수 있게 되면 게시됩니다.

1장. 소개

Red Hat Virtualization Manager는 REST(Representational State Transfer) API 를 제공합니다. API는 소프트웨어 개발자와 시스템 관리자가 표준 웹 인터페이스 외부에서 Red Hat Virtualization 환경을 제어할 수 있습니다. API는 개발자와 관리자가 표준 하이퍼텍스트 전송 프로토콜(HTTP)을 통해 API에 액세스하는 사용자 지정 스크립트 또는 외부 애플리케이션과 Red Hat Virtualization 환경의 기능을 통합하는 데 유용합니다.

API의 장점은 다음과 같습니다.

  • 광범위한 클라이언트 지원 - HTTP 프로토콜 지원이 있는 모든 프로그래밍 언어, 프레임워크 또는 시스템은 API를 사용할 수 있습니다.
  • 자체 설명 - 클라이언트 애플리케이션은 런타임 시 많은 세부 정보가 검색되므로 가상화 인프라에 대한 최소한의 지식이 필요합니다.
  • 리소스 기반 모델 - 리소스 기반 REST 모델은 가상화 플랫폼을 관리하는 자연스러운 방법을 제공합니다.

이는 개발자와 관리자에게 다음과 같은 기능을 제공합니다.

  • 엔터프라이즈 IT 시스템과의 통합.
  • 타사 가상화 소프트웨어와 통합.
  • 자동화된 유지 관리 또는 오류 확인 작업을 수행합니다.
  • 스크립트를 사용하여 Red Hat Virtualization 환경에서 반복적인 작업을 자동화합니다.

이 문서는 Red Hat Virtualization API에 대한 참조 역할을 합니다. 개발자 및 관리자에게 제공된 SDK를 직접 또는 사용하는 API를 통해 Red Hat Virtualization 환경의 기능을 활용할 수 있는 지침과 예제를 제공하는 것을 목표로 합니다.

1.1. REST(Representational State Transfer)

REST(Representational State Transfer) 는 특정 서비스 및 해당 표현의 리소스에 중점을 둔 설계 아키텍처입니다. 리소스 표현은 서버의 특정 관리 요소에 해당하는 정보의 주요 추상화입니다. 클라이언트는 URI(Uniform Resource Identifier)에 있는 서버 요소에 요청을 보내고 GET,POST,PUT, DELETE 와 같은 표준 HTTP 메서드를 사용하여 작업을 수행합니다. 이는 각 요청이 다른 요청과 독립적으로 작동하며 요청을 완료하는 데 필요한 모든 정보를 포함하는 클라이언트와 서버 간에 상태 비저장 통신을 제공합니다.

1.1.1. API 사전 요구 사항

Red Hat Virtualization API 사용을 위한 사전 요구 사항:

  • API를 포함하는 Red Hat Virtualization Manager의 네트워크 설치.
  • API 서버에서 HTTP 요청을 시작하고 수신하는 클라이언트 또는 프로그래밍 라이브러리(예:).

  • REST API 상호 작용에 사용되는 프로토콜인 하이퍼텍스트 전송 프로토콜(HTTP)에 대한 지식. RFC 2616: HTTP/1.1 를 참조하십시오.
  • API가 리소스 표현을 구성하는 데 사용하는 XML(Extensible Markup Language) 또는 JavaScript Object Notation(JSON)에 대한 지식입니다. W3C XML(Extensible Markup Language) 1.0ECMA-404: JSON 데이터 exchange 구문을 참조하십시오.

2장. 인증 및 보안

2.1. TLS/SSL 인증

Red Hat Virtualization API에는 Hypertext Transfer Protocol Secure (HTTPS) footnote:[ RFC 2818: HTTP over TLS 를 참조하여 SDK 및 CLI 구성 요소와 같은 클라이언트 소프트웨어와의 보안 상호 작용이 필요합니다. 여기에는 서버에서 사용하는 CA 인증서를 가져와 클라이언트의 인증서 저장소로 가져옵니다.

2.1.1. CA 인증서 가져오기

Red Hat Virtualization Manager에서 CA 인증서를 가져와서 다음 방법 중 하나를 사용하여 클라이언트 머신에 전송할 수 있습니다.

방법 1

CA 인증서를 얻는 기본 방법은 openssl s_client 명령줄 툴을 사용하여 서버와 함께 실제 TLS 핸드셰이크를 수행한 다음 해당 서버에서 제공하는 인증서를 추출하는 것입니다.

  1. 다음 예와 같이 openssl s_client 명령을 실행합니다.

    $ openssl s_client \
    -connect myengine.example.com:443 \
    -showcerts \
    < /dev/null

    출력 예

    CONNECTED(00000003)
    depth=1 C = US, O = Example Inc., CN = myengine.example.com.23416
    verify error:num=19:self signed certificate in certificate chain
    ---
    Certificate chain
     0 s:/C=US/O=Example Inc./CN=myengine.example.com
       i:/C=US/O=Example Inc./CN=myengine.example.com.23416
    -----BEGIN CERTIFICATE-----
    MIIEaTCCA1GgAwIBAgICEAQwDQYJKoZIhvcNAQEFBQAwSTELMAkGA1UEBhMCVVMx
    FTATBgNVBAoTDEV4YW1wbGUgSW5jLjEjMCEGA1UEAxMaZW5naW5lNDEuZXhhbXBs
    SVlJe7e5FTEtHJGTAeWWM6dGbsFhip5VXM0gfqg=
    -----END CERTIFICATE-----
     1 s:/C=US/O=Example Inc./CN=myengine.example.com.23416
       i:/C=US/O=Example Inc./CN=myengine.example.com.23416
    -----BEGIN CERTIFICATE-----
    MIIDxjCCAq6gAwIBAgICEAAwDQYJKoZIhvcNAQEFBQAwSTELMAkGA1UEBhMCVVMx
    FTATBgNVBAoTDEV4YW1wbGUgSW5jLjEjMCEGA1UEAxMaZW5naW5lNDEuZXhhbXBs
    Pkyg1rQHR6ebGQ==
    -----END CERTIFICATE-----

    -----BEGIN CERTIFICATE--- 및 ---- END CERTIFICATE ---- 행 간의 텍스트에는 서버에서 제공하는 인증서가 표시됩니다.

    첫 번째 인증서는 서버 자체의 인증서입니다. 두 번째 인증서는 CA의 인증서입니다.

  2. 다음과 같이 CA 인증서를 -----BEGIN CERTIFICATE ---- 및 ---- END CERTIFICATE----- 행을 포함하여 CA 인증서를 ca.crt 파일에 복사합니다.

    -----BEGIN CERTIFICATE-----
    MIIDxjCCAq6gAwIBAgICEAAwDQYJKoZIhvcNAQEFBQAwSTELMAkGA1UEBhMCVVMx
    FTATBgNVBAoTDEV4YW1wbGUgSW5jLjEjMCEGA1UEAxMaZW5naW5lNDEuZXhhbXBs
    Pkyg1rQHR6ebGQ==
    -----END CERTIFICATE-----
    중요

    이는 서버에서 사용하는 CA 인증서를 가져오는 가장 신뢰할 수 있는 방법입니다. 여기에 설명된 나머지 방법은 대부분의 경우 작동하지만 인증서를 서버 관리자가 수동으로 교체한 경우 올바른 CA 인증서를 가져오지 않습니다.

방법 2

openssl s_client 를 사용하여 인증서를 가져올 수 없는 경우 명령줄 도구(예: curl 또는 wget )를 사용하여 Red Hat Virtualization Manager에서 CA 인증서를 다운로드할 수 있습니다. curlwget 은 여러 플랫폼에서 사용할 수 있습니다.

  • curl 을 사용하는 경우:

    $ curl \
    --output ca.crt \
    'http://myengine.example.com/ovirt-engine/services/pki-resource?resource=ca-certificate&format=X509-PEM-CA'
  • wget 을 사용하는 경우:

    $ wget \
    --output-document ca.crt \
    'http://myengine.example.com/ovirt-engine/services/pki-resource?resource=ca-certificate&format=X509-PEM-CA'
방법 3

웹 브라우저를 사용하여 'https://myengine.example.com/ovirt-engine/services/pki-resource?resource=ca-certificate&format=X509-PEM-CA`에 있는 인증서로 이동합니다.

선택한 브라우저에 따라 인증서가 다운로드되거나 브라우저의 키 저장소로 가져옵니다.

  • 브라우저가 인증서를 다운로드하는 경우 파일을 ca.crt 로 저장합니다.
  • 브라우저가 인증서를 가져오는 경우 브라우저의 인증서 관리 옵션을 사용하여 내보낸 후 ca.crt 로 저장합니다.
방법 4

Red Hat Virtualization Manager에 로그인하고 truststore에서 인증서를 내보낸 후 클라이언트 머신에 복사합니다.

  1. Red Hat Virtualization Manager 시스템에 root 로 로그인합니다.
  2. Java keytool 관리 유틸리티를 사용하여 truststore에서 인증서를 내보냅니다.

    # keytool \
    -keystore /etc/pki/ovirt-engine/.truststore \
    -storepass mypass \
    -exportcert \
    -alias cacert \
    -rfc \
    -file ca.crt

    이렇게 하면 ca.crt 라는 인증서 파일이 생성됩니다.

  3. scp 명령을 사용하여 클라이언트 시스템에 인증서를 복사합니다.

    $ scp ca.crt myuser@myclient.example.com:/home/myuser/.

    이러한 각 방법은 클라이언트 시스템의 ca.crt 라는 인증서 파일을 생성합니다. 그런 다음 이 파일을 클라이언트의 인증서 저장소로 가져와야 합니다.

2.1.2. 인증서를 클라이언트로 가져오기

클라이언트에서 인증서를 가져오는 방법은 클라이언트가 인증서를 저장하고 해석하는 방법에 의존합니다. 인증서 가져오기에 대한 자세한 내용은 클라이언트 설명서를 참조하십시오.

2.2. 인증

Red Hat Virtualization Manager 계정이 있는 모든 사용자는 API에 액세스할 수 있습니다. 모든 요청은 아래에 설명된 대로 OAuth 또는 기본 인증을 사용하여 인증해야 합니다.

2.2.1. OAuth 인증

Red Hat Virtualization 버전 4.0 이후 기본 인증 메커니즘은 OAuth 2.0 이며 RFC 6749 에 설명되어 있습니다.

OAuth 는 권한 부여 및 액세스 토큰을 얻기 위한 몇 가지 메커니즘이 포함된 정교한 프로토콜입니다. Red Hat Virtualization API에서 사용할 수 있는 유일한 지원은 RFC 6749 에 설명된 대로 리소스 소유자 암호 자격 증명 부여 입니다.

먼저 토큰을 가져와서 사용자 이름과 암호를 Red Hat Virtualization Manager Single Sign-On 서비스로 보내야 합니다.

POST /ovirt-engine/sso/oauth/token HTTP/1.1
Host: myengine.example.com
Content-Type: application/x-www-form-urlencoded
Accept: application/json

요청 본문에는 grant_type,범위,사용자 이름, 암호 매개변수가 포함되어야 합니다.

Expand
표 2.1. OAuth 토큰 요청 매개변수
이름

grant_type

암호

scope

ovirt-app-api

사용자 이름

admin@internal

암호

mypassword

이러한 매개변수는 URL로 인코딩 되어야 합니다. 예를 들어 사용자 이름의 @ 문자는 %40 으로 인코딩되어야 합니다. 결과 요청 본문은 다음과 같습니다.The resulting request body will be something like this:

grant_type=password&scope=ovirt-app-api&username=admin%40internal&password=mypassword
중요

scope 매개변수는 OAuth RFC에서 선택 사항으로 설명되지만 Red Hat Virtualization API와 함께 사용할 때는 필수이며 해당 값은 ovirt-app-api 여야 합니다.

사용자 이름과 암호가 유효한 경우 Red Hat Virtualization Manager Single Sign-On 서비스는 다음과 유사한 JSON 문서로 응답합니다.

{
  "access_token": "fqbR1ftzh8wBCviLxJcYuV5oSDI=",
  "token_type": "bearer",
  "scope": "...",
  ...
}

API 인증의 경우 관련 이름/값 쌍만 access_token 입니다. 어떤 방식으로든 이 작업을 조작하지 마십시오. SSO 서비스에서 제공하는 대로 정확하게 사용하십시오.

토큰이 획득되면 HTTP Authorization 헤더에 포함하고 Bearer 스키마를 사용하여 API에 대한 요청을 수행할 수 있습니다. 예를 들어 가상 머신 목록을 가져오려면 다음과 같은 요청을 보냅니다.

GET /ovirt-engine/api/vms HTTP/1.1
Host: myengine.example.com
Accept: application/xml
Authorization: Bearer fqbR1ftzh8wBCviLxJcYuV5oSDI=

토큰은 여러 요청에 여러 번 사용할 수 있지만 결국 만료됩니다. 만료되면 서버는 401 HTTP 응답 코드와 함께 요청을 거부합니다.

HTTP/1.1 401 Unauthorized

이러한 상황이 발생하면 Red Hat Virtualization Manager Single Sign-On 서비스에서 현재 새로 고침 토큰을 지원하지 않으므로 새 토큰이 필요합니다. 위에서 설명한 것과 동일한 방법을 사용하여 새 토큰을 요청할 수 있습니다.

2.2.2. 기본 인증

중요

기본 인증은 이전 버전과의 호환성을 위해서만 지원됩니다. Red Hat Virtualization 버전 4.0부터 사용되지 않으며 향후 제거될 예정입니다.

각 요청에서 HTTP 기본 인증을 사용합니다. [1] 인증 정보를 인코딩하려면 다음을 수행합니다. 요청에 적절한 Authorization 헤더가 포함되지 않은 경우 서버는 401 Authorization Required 응답을 보냅니다.

HEAD /ovirt-engine/api HTTP/1.1
Host: myengine.example.com

HTTP/1.1 401 Authorization Required

요청은 지정된 영역에 대한 Authorization 헤더를 사용하여 발행됩니다. 사용자 이름@domain:password 규칙을 사용하여 제공된 인증 정보에서 적절한 Red Hat Virtualization Manager 도메인 과 사용자를 인코딩합니다.

다음 표에서는 Base64 에서 자격 증명을 인코딩하는 프로세스를 보여줍니다.

Expand
표 2.2. API 액세스를 위한 인증 정보 인코딩
항목

사용자 이름

admin

domain

internal

암호

mypassword

인코딩되지 않은 인증 정보

admin@internal:mypassword

base64로 인코딩된 인증 정보

YWRtaW5AaW50ZXJuYWw6bXlwYXNzd29yZA==

다음과 같이 Base64로 인코딩된 인증 정보를 제공합니다.

HEAD /ovirt-engine/api HTTP/1.1
Host: myengine.example.com
Authorization: Basic YWRtaW5AaW50ZXJuYWw6bXlwYXNzd29yZA==

HTTP/1.1 200 OK
중요

기본 인증에는 일반 텍스트로 전송되는 암호와 같은 잠재적으로 민감한 정보가 포함됩니다. API에는 일반 텍스트 요청의 전송 수준 암호화를 위해 HTTPS(Hypertext Transfer Protocol Secure)가 필요합니다.

중요

일부 Base64 라이브러리는 결과를 여러 줄로 분할하고 각 행을 줄 바꿈 문자로 종료합니다. 이렇게 하면 헤더가 끊어지고 잘못된 요청이 발생합니다. Authorization 헤더에는 헤더 내에서 한 줄에 인코딩된 인증 정보가 필요합니다.

2.2.3. 인증 세션

API는 인증 세션 지원도 제공합니다. 인증 세부 정보가 있는 초기 요청을 보낸 다음 세션 쿠키를 사용하여 모든 후속 요청을 전송하여 인증합니다.

2.2.3.1. 인증된 세션 요청
  1. AuthorizationPrefer: persistent-auth 헤더를 사용하여 요청을 보냅니다.

    HEAD /ovirt-engine/api HTTP/1.1
    Host: myengine.example.com
    Authorization: Basic YWRtaW5AaW50ZXJuYWw6bXlwYXNzd29yZA==
    Prefer: persistent-auth
    
    HTTP/1.1 200 OK
    ...

    그러면 다음 헤더가 있는 응답을 반환합니다.

    Set-Cookie: JSESSIONID=5dQja5ubr4yvI2MM2z+LZxrK; Path=/ovirt-engine/api; Secure

    JSESSIONID= 값을 기록해 둡니다. 이 예제에서 값은 5dQja5ubr4yvI2MM2z+LxrK 입니다.

  2. JSESSIONID= 값을 사용하여 Prefer: persistent-auth cookies 헤더를 사용하여 모든 후속 요청을 전송합니다. 인증된 세션을 사용할 때 Authorization 헤더가 더 이상 필요하지 않습니다.

    HEAD /ovirt-engine/api HTTP/1.1
    Host: myengine.example.com
    Prefer: persistent-auth
    Cookie: JSESSIONID=5dQja5ubr4yvI2MM2z+LZxrK
    
    HTTP/1.1 200 OK
    ...
  3. 세션이 더 이상 필요하지 않은 경우 Prefer: persistent-auth 헤더 없이 서버에 대한 요청을 수행합니다.

    HEAD /ovirt-engine/api HTTP/1.1
    Host: myengine.example.com
    Authorization: Basic YWRtaW5AaW50ZXJuYWw6bXlwYXNzd29yZA==
    
    HTTP/1.1 200 OK
    ...


[1] 기본 인증은 RFC 2617: HTTP Authentication: Basic and#150 Access Authentication 에 설명되어 있습니다.

3장. 공통 개념

3.1. 유형

API는 유형 개념을 사용하여 수락되고 반환된 다양한 종류의 오브젝트를 설명합니다.

다음과 같은 세 가지 유형의 유형이 있습니다.

기본 유형
문자열 또는 정수 와 같은 간단한 종류의 개체를 설명합니다.
열거된 유형
VmStatus 또는 DiskFormat 과 같은 유효한 값 목록을 설명합니다.
구조화된 유형
Vm 또는 Disk 와 같은 여러 속성과 링크가 포함된 구조화된 오브젝트를 설명합니다.

3.2. 확인된 유형

API에서 사용하는 많은 유형이 식별되는 오브젝트, 고유 식별자가 있고 다른 오브젝트와 독립적으로 존재하는 오브젝트를 나타냅니다. 이러한 개체를 설명하는 데 사용되는 형식은 다음과 같은 공통 특성 집합을 포함하는 Identified 유형을 확장합니다.

Expand
속성유형설명

id

문자열

가상화 인프라의 각 오브젝트에는 고유 식별자 역할을 하는 id 가 포함되어 있습니다.

href

문자열

개체의 표준 위치입니다. 절대 경로입니다.

name

문자열

사용자가 읽을 수 있는 오브젝트의 이름입니다. 이름 이름은 동일한 유형의 모든 개체에서 고유합니다.

description

문자열

오브젝트에 대한 자유 형식 사용자가 사람이 읽을 수 있는 설명을 제공합니다.

중요

현재 대부분의 오브젝트 유형에서 id 속성은 실제로 무작위로 생성된 UUID 이지만, 이는 구현 세부 정보이며 사용자는 나중에 변경될 수 있으므로 이 정보를 사용하지 않아야 합니다. 대신 사용자는 이러한 식별자가 단순히 문자열이라고 가정해야 합니다.

3.3. Objects

오브젝트는 API에서 지원하는 유형의 개별 인스턴스입니다. 예를 들어, 식별자가 123 인 가상 시스템은 Vm 유형의 오브젝트입니다.

3.4. 컬렉션

컬렉션은 동일한 형식의 개체 집합입니다.A collection is a set of objects of the same type.

3.5. representations

오브젝트의 상태는 클라이언트와 서버가 전송될 때 표시되어야 합니다. API는 입력 및 출력에 대해 오브젝트 상태를 나타내는 XML 및 JSON을 지원합니다.

3.5.1. XML 표현

개체의 XML 표현은 개체의 형식에 해당하는 XML 요소, idhref 특성에 대한 XML 속성, 나머지 특성에 대해 중첩된 XML 요소로 구성됩니다. 예를 들어 가상 머신의 XML 표현은 다음과 같습니다.

<vm id="123" href="/ovirt-engine/api/vms/123">
  <name>myvm</name>
  <description>My VM</description>
  <memory>1073741824</memory>
  ...
</vm>

개체 컬렉션의 XML 표현은 여러 개체의 형식 뒤에 지정된 XML 요소로 구성됩니다.The XML representation of a collection of objects consists of an XML element, named after the type of the objects, in plural. 컬렉션의 개체의 표현을 포함합니다.This contains the representations of the objects of the collection. 예를 들어 가상 머신 컬렉션에 대한 XML 반환은 다음과 같습니다.

<vms>
  <vm id="123" href="/ovirt-engine/api/vms/123">
    <name>yourvm</name>
    <description>Your VM</description>
    <memory>1073741824</memory>
    ...
  </vm>
  <vm id="456" href="/ovirt-engine/api/vms/456">
    <name>myname</name>
    <description>My description</description>
    <memory>2147483648</memory>
    ...
  </vm>
  ...
</vms>
중요

개체의 XML 표현에서 idhref 특성은 XML 속성으로 표시되는 유일한 속성이며 나머지는 중첩된 XML 요소로 표시됩니다.

3.5.2. JSON 표현

오브젝트의 JSON 표현은 각 속성( IDhref포함)에 대한 이름/값 쌍을 포함하는 JSON 문서로 구성됩니다. 예를 들어 가상 머신의 JSON 표시는 다음과 같습니다.

{
  "id": "123",
  "href": "/ovirt-engine/api/vms/123",
  "name": "myvm",
  "description": "My VM",
  "memory": 1073741824,
  ...
}

오브젝트 컬렉션의 JSON 표현은 JSON 문서의 이름/값 쌍(오틀 형식)으로 구성되며, 이에는 컬렉션의 개체가 포함된 배열이 포함되어 있습니다. 예를 들어 가상 머신 컬렉션에 대한 JSON respresentation은 다음과 같습니다.

{
  "vm": [
    {
      "id": "123",
      "href": "/ovirt-engine/api/vms/123",
      "name": "myvm",
      "description": "My VM",
      "memory": 1073741824,
      ...
    },
    {
      "id": "456",
      "href": "/ovirt-engine/api/vms/456",
      "name": "yourvm",
      "description": "Your VM",
      "memory": 2147483648,
      ...
    },
  ]
}

3.6. 서비스

서비스는 API에서 지원하는 오브젝트에 대한 작업을 검색, 업데이트, 제거 및 실행하는 서버의 일부입니다.

다음과 같은 두 가지 유형의 서비스가 있습니다.

오브젝트 컬렉션을 관리하는 서비스
이러한 서비스는 기존 오브젝트를 나열하고 새 오브젝트를 추가할 수 있는 리포지토리입니다. 예를 들어 Vms 서비스는 시스템에서 사용 가능한 가상 머신의 컬렉션을 관리합니다.
특정 오브젝트를 관리하는 서비스
이러한 서비스는 특정 오브젝트에서 작업을 검색, 업데이트, 삭제 및 실행하는 역할을 담당합니다. 예를 들어 Vm 서비스는 특정 가상 머신을 관리합니다.

각 서비스는 서버 내에서 특정 경로 를 통해 액세스할 수 있습니다. 예를 들어 시스템에서 사용 가능한 가상 머신 컬렉션을 관리하는 서비스는 /vms 경로를 통해 에서 사용할 수 있으며, 가상 머신 123 을 관리하는 서비스는 /vms/123 을 통해 사용할 수 있습니다.

모든 종류의 서비스에는 수행할 수 있는 작업을 나타내는 일련의 메서드 가 있습니다. 오브젝트 컬렉션을 관리하는 서비스에는 일반적으로 목록추가 메서드가 있습니다. 특정 오브젝트를 관리하는 서비스에는 일반적으로 get,updateremove 메서드가 있습니다. 또한 서비스에는 덜 일반적인 작업을 나타내는 동작 메서드가 있을 수도 있습니다. 예를 들어 Vm 서비스에는 가상 시스템을 시작하는 데 사용되는 시작 방법이 있습니다.

더 일반적인 메서드의 경우 메서드 이름과 HTTP 메서드 이름 사이에 직접 매핑이 있습니다.For the more usual methods there is a direct mapping between the name of the method and the name of the HTTP method:

Expand
메서드 이름HTTP 방법

add

POST

get

GET

list

GET

update

PUT

제거

DELETE

HTTP 요청에 사용된 경로는 /ovirt-engine/api 접두사가 있는 서비스의 경로입니다.

예를 들어, 가상 머신 목록 요청은 HTTP GET 메서드와 /vms 경로를 사용하여 다음과 같아야 합니다.

GET /ovirt-engine/api/vms

작업 메서드의 경우 HTTP 메서드는 항상 POST 이며 메서드의 이름은 경로에 접미사로 추가됩니다.For action methods the HTTP method is always POST , and the name of the method is added as a suffix to the path. 예를 들어 가상 머신( 123 )을 시작하는 요청은 HTTP POST 메서드와 /vms/123/start 경로를 사용하여 다음과 같아야 합니다.

POST /ovirt-engine/api/vms/123/start

각 방법에는 매개 변수 집합이 있습니다.

매개변수는 다음 두 가지 범주로 분류됩니다.

기본 매개변수
main 매개변수는 검색, 추가 또는 업데이트되는 오브젝트 또는 컬렉션에 해당합니다. 이 매개 변수는 add,get,listupdate 메서드에만 적용되며, 메서드당 이러한 기본 매개 변수 하나만 있습니다.
보조 매개변수
나머지 매개 변수

예를 들어 가상 시스템을 추가하는 작업에는 vm,cloneclone_permissions 라는 세 가지 매개 변수가 있습니다. main 매개 변수는 추가된 오브젝트를 설명하는 vm 입니다. cloneclone_permissions 매개변수는 보조 매개 변수입니다.

input에 사용할 때 main 매개변수는 HTTP 요청의 본문에 포함되어야 합니다. 예를 들어 가상 머신을 추가할 때 Vm 유형의 vm 매개 변수를 요청 본문에 포함해야 합니다. 따라서 모든 HTTP 세부 정보를 포함하여 가상 머신 추가 요청은 다음과 같아야 합니다.

POST /ovirt-engine/api/vms HTTP/1.1
Host: myengine.example.com
Authorization: Bearer fqbR1ftzh8wBCviLxJcYuV5oSDI=
Content-Type: application/xml
Accept: application/xml

<vm>
  <name>myvm</name>
  <description>My VM</description>
  <cluster>
    <name>Default</name>
  </cluster>
  <template>
    <name>Blank</name>
  </template>
</vm>

출력에 사용하면 기본 매개변수가 응답 본문에 포함됩니다. 예를 들어 가상 머신을 추가할 때 vm 매개 변수는 응답 본문에 포함됩니다. 따라서 전체 응답 본문은 다음과 같습니다.

HTTP/1.1 201 Created
Content-Type: application/xml

<vm href="/ovirt-engine/api/vms/123" id="123">
  <name>myvm</name>
  <description>My VM</description>
  ...
</vm>

보조 매개변수는 입력에만 허용됩니다(나중에 설명되는 작업 메서드 제외) 쿼리 매개 변수로 포함되어야 합니다. 예를 들어 clone 매개 변수가 true 로 설정된 가상 머신을 추가하는 경우 전체 요청은 다음과 같아야 합니다.

POST /ovirt-engine/api/vms?clone=true HTTP/1.1
Host: myengine.example.com
Authorization: Bearer fqbR1ftzh8wBCviLxJcYuV5oSDI=
Content-Type: application/xml
Accept: application/xml

<vm>
  <name>myvm</name>
  <description>My VM</description>
  <cluster>
    <name>Default</name>
  </cluster>
  <template>
    <name>Blank</name>
  </template>
</vm>

작업 방법에는 보조 매개 변수만 있습니다. 입력 및 출력에 사용할 수 있으며 작업 요소로 래핑된 요청 본문에 포함되어야 합니다. 예를 들어 가상 시스템을 시작하는 데 사용되는 작업 방법에는 vm 매개 변수가 있어가상 시스템을 시작하는 방법을 설명하고, use_cloud_init 매개 변수를 사용하여 게스트 운영 체제를 구성해야 하는지 여부를 지정합니다. https://cloudinit.readthedocs.io 따라서 cloud-init 를 사용하여 가상 머신 123 을 시작하는 전체 요청은 XML을 사용할 때 다음과 같이 표시됩니다.

POST /ovirt-engine/api/vms/123/start HTTP/1.1
Host: myengine.example.com
Authorization: Bearer fqbR1ftzh8wBCviLxJcYuV5oSDI=
Content-Type: application/xml
Accept: application/xml

<action>
  <use_cloud_init>true</use_cloud_init>
  <vm>
    <initialization>
      <nic_configurations>
        <nic_configuration>
          <name>eth0</name>
          <on_boot>true</on_boot>
          <boot_protocol>static</boot_protocol>
          <ip>
            <address>192.168.0.100</address>
            <netmask>255.255.255.0</netmask>
            <gateway>192.168.0.1</netmask>
          </ip>
        </nic_configuration>
      </nic_configurations>
      <dns_servers>192.168.0.1</dns_servers>
    </initialization>
  </vm>
</action>

3.7. 검색

일부 서비스의 list 방법에는 검색 기준을 지정하는 데 사용할 수 있는 search 매개 변수가 있습니다. 사용하는 경우 서버는 이러한 조건을 충족하는 컬렉션 내의 개체만 반환합니다. 예를 들어 다음 요청에서는 myvm 이라는 가상 머신만 반환합니다.

GET /ovirt-engine/api/vms?search=name%3Dmyvm

3.7.1. 최대 결과 매개변수

max 매개변수를 사용하여 반환된 오브젝트 수를 제한합니다. 예를 들어 다음 요청에서는 시스템에서 사용할 수 있는 수에 관계없이 하나의 가상 머신만 반환합니다.

GET /ovirt-engine/api/vms?max=1

max 매개변수가 없는 검색 요청은 모든 오브젝트를 반환합니다. 시스템의 전반적인 성능에 대한 요청의 영향을 줄이기 위해 max 매개변수를 지정하는 것이 좋습니다.

3.7.2. 케이스 민감도

기본적으로 쿼리는 대소문자를 구분하지 않습니다. 예를 들어 다음 요청에서는 myvm,MyVMMYVM 이라는 가상 머신을 반환합니다.

GET /ovirt-engine/api/vms?search=name%3Dmyvm

선택적 case_sensitive 부울 매개변수를 사용하여 이 동작을 변경할 수 있습니다. 예를 들어 MyHost 또는 MYHOST 가 아닌 myhost 라는 가상 머신을 정확히 얻으려면 다음과 같은 요청을 보냅니다.

GET /ovirt-engine/api/vms?search=name%3D=myvm&case_sensitive=true

3.7.3. 검색 구문

검색 매개변수는 Red Hat Virtualization 쿼리 언어와 동일한 구문을 사용합니다.

(criteria) [sortby (element) asc|desc]

sortby 절은 선택 사항이며 결과를 정렬할 때만 필요합니다.

검색 쿼리 예:

Expand
소프트웨어 컬렉션기준결과

호스트

vms.status=up

실행 중인 가상 머신을 실행하는 모든 호스트 목록을 반환합니다.

vms

domain=example.com

지정된 도메인에서 실행 중인 모든 가상 머신 목록을 반환합니다.

vms

users.name=mary

사용자 이름이 mary 인 사용자에게 속한 모든 가상 머신 목록을 반환합니다.

events

심각도 > 정상적인 정렬 시간

심각도가 normal 보다 높고 시간 특성 값을 기준으로 정렬되는 모든 이벤트 목록을 반환합니다.

events

심각도 > 정상적인 정렬 시간

심각도가 normal 보다 높고 시간 특성 값을 내림차순으로 정렬한 모든 이벤트 목록을 반환합니다.

search 매개변수 값은 연산자 및 공백과 같은 예약된 문자를 변환하기 위해 URL로 인코딩 되어야 합니다. 예를 들어 등호는 %3D 로 인코딩되어야 합니다.

GET /ovirt-engine/api/vms?search=name%3Dmyvm

3.7.4. 와일드카드

별표는 값의 일부로 사용하여 emtpy 문자열을 포함하여 일치하는 문자열이 있음을 나타낼 수 있습니다. 예를 들어 다음 요청에서는 myvm ,myvm2, myvm a 또는 myvm -webserver 와 같이 이름이 myvm으로 시작하는 모든 가상 머신을 반환합니다.

GET /ovirt-engine/api/vms?search=name%3Dmyvm*

3.7.5. 페이지 번호

일부 Red Hat Virtualization 환경에는 대규모 오브젝트 컬렉션이 포함되어 있습니다. 하나의 요청으로 모두를 검색하는 것은 실용적이지 않으며 성능이 저하됩니다. 페이지별로 페이지를 검색할 수 있도록 search 매개 변수는 선택적 페이지 절을 지원합니다. max 매개변수와 함께 이 값은 페이징 기준으로 사용됩니다. 예를 들어 페이지 크기가 10개인 가상 머신의 첫 번째 페이지를 가져오려면 다음과 같이 요청을 보냅니다.

GET /ovirt-engine/api/vms?search=page%201&max=10
참고

search 매개변수는 인코딩하기 전에 URL로 인코딩된 URL로 인코딩되어 있으므로 실제로 첫 번째 페이지를 요청하는 것입니다.

페이지 값을 늘려 다음 페이지를 검색합니다.

GET /ovirt-engine/api/vms?search=page%202&max=10

page 절은 search 매개변수 내부의 다른 절과 함께 사용할 수 있습니다. 예를 들어 다음 요청에서는 가상 머신의 두 번째 페이지를 반환하지만 이름으로 정렬됩니다.

GET /ovirt-engine/api/vms?search=sortby%20name%20page%202&max=10
중요

API는 상태 비저장이며 모든 요청이 서로 독립적이므로 서로 다른 요청 간에 상태를 유지할 수 없습니다. 결과적으로 요청 간에 상태 변경이 발생하면 페이지 결과가 일관되지 않을 수 있습니다.

예를 들어 가상 머신 목록의 특정 페이지를 요청하고 다음 페이지를 요청하기 전에 가상 머신이 생성 또는 제거되면 결과 중 일부가 누락되거나 중복이 포함될 수 있습니다.

3.8. 링크 다음

API는 관련 오브젝트에 대한 참조를 링크로 반환합니다. 예를 들어 가상 머신이 검색되면 디스크 연결 및 네트워크 인터페이스 카드에 대한 링크가 포함됩니다.

<vm id="123" href="/ovirt-engine/api/vms/123">
  ...
  <link rel="diskattachments" href="/ovirt-engine/api/vms/123/diskattachments"/>
  <link rel="nics" href="/ovirt-engine/api/vms/123/nics"/>
  ...
</vm>

연결된 오브젝트에 대한 전체 설명은 별도의 요청을 전송하여 검색할 수 있습니다.

GET /ovirt-engine/api/vms/123/diskattachments
GET /ovirt-engine/api/vms/123/nics

그러나 경우에 따라 동일한 요청에서 연결된 정보를 검색하기 위해 API를 사용하는 애플리케이션이 더 편리합니다. 예를 들어 추가 네트워크 왕복에서 허용되지 않는 오버헤드가 발생할 때 또는 다중 요청이 불안정한 방식으로 애플리케이션 코드를 복잡할 때 유용합니다. 이러한 사용 사례의 경우 API는 애플리케이션이 하나의 요청만 사용하여 연결된 정보를 검색할 수 있는 follow 매개 변수를 제공합니다.

다음 매개 변수의 값은 쉼표로 구분된 문자열 목록입니다. 이러한 각 문자열은 연결된 개체의 경로 입니다. 예를 들어 위의 예에서 디스크 첨부 파일 및 NIC를 검색하려면 요청의 다음과 같아야 합니다.

GET /ovirt-engine/api/vms/123?follow=disk_attachments,nics

그러면 다음과 같은 응답이 반환됩니다.

<vm id="123" href="/ovirt-engine/api/vms/123">
  ...
  <disk_attachments>
    <disk_attachment id="456" href="/ovirt-engine/api/vms/123/diskattachments/456">
      <active>true</active>
      <bootable>true</bootable>
      <interface>virtio_scsi</interface>
      <pass_discard>false</pass_discard>
      <read_only>false</read_only>
      <uses_scsi_reservation>false</uses_scsi_reservation>
      <disk id="789" href="/ovirt-engine/api/disks/789"/>
    </disk_attachment>
    ...
  </disk_attacments>
  <nics>
    <nic id="234" href="/ovirt-engine/api/vms/123/nics/234">
      <name>eth0</name>
      <interface>virtio</interface>
      <linked>true</linked>
      <mac>
        <address>00:1a:4a:16:01:00</address>
      </mac>
      <plugged>true</plugged>
    </nic>
    ...
  </nics>
  ...
</vm>

연결된 개체의 경로는 이전 예제와 같이 단일 단어일 수 있거나 중첩된 데이터를 요청하기 위해 점으로 구분된 일련의 단어일 수 있습니다. 예를 들어 이전 예제에서는 disk_attachments 를 사용하여 디스크 첨부 파일의 전체 설명을 검색했지만 각 디스크 연결에는 디스크 링크가 포함되어 있습니다. 디스크에 대한 링크도 따르려면 다음 요청을 사용할 수 있습니다.

GET /ovirt-engine/api/vms/123?follow=disk_attachments.disk

그러면 다음과 같은 응답이 표시됩니다.

<vm id="123" href="/ovirt-engine/api/vms/123">
  <disk_attachments>
    <disk_attachment id="456" href="/ovirt-engine/api/vms/123/diskattachments/456">
      <active>true</active>
      <bootable>true</bootable>
      <interface>virtio_scsi</interface>
      <pass_discard>false</pass_discard>
      <read_only>false</read_only>
      <uses_scsi_reservation>false</uses_scsi_reservation>
      <disk id="789" href="/ovirt-engine/api/disks/789">
        <name>mydisk</name>
        <description>My disk</description>
        <actual_size>0</actual_size>
        <format>raw</format>
        <sparse>true</sparse>
        <status>ok</status>
        <storage_type>image</storage_type>
        <total_size>0</total_size>
        ...
      </disk>
    </disk_attachment>
    ...
  </disk_attachments>
  ...
</vm>

경로는 필요에 따라 자세히 만들 수 있습니다. 예를 들어 디스크의 통계도 가져오려면 다음을 수행합니다.

GET /ovirt-engine/api/vms/123?follow=disk_attachments.disk.statistics

여러 경로 요소와 여러 경로를 결합할 수 있습니다. 예를 들어 디스크 연결 및 네트워크 인터페이스 카드를 가져오려면 둘 다 통계가 있습니다.

GET /ovirt-engine/api/vms/123?follow=disk_attachments.disk.statistics,nics.statistics
중요

오브젝트를 검색하는 거의 모든 작업은 follow 매개 변수를 지원하지만 일부 작업에서 지원하지 않을 수 있으므로 참조 문서를 명시적으로 확인하거나 최상의 성능을 얻기 위해 사용하는 방법에 대한 조언을 제공할 수 있습니다.

중요

다음 매개 변수를 사용하여 오버헤드를 클라이언트 측에서 서버 측으로 이동합니다. 추가 데이터를 요청할 때 서버에서 기본 데이터를 가져와서 병합해야 합니다. 서버 측에서 CPU 및 메모리를 사용하는 경우 대부분의 경우 추가 데이터베이스 쿼리가 필요합니다. 이는 특히 대규모 환경에서 서버의 성능에 부정적인 영향을 미칠 수 있습니다. 실제 환경에서 애플리케이션을 테스트하고 방금 설명한 경우에만 다음 매개 변수를 사용하십시오.

3.9. 권한

단일 개체를 관리하는 대부분의 서비스는 해당 개체에 할당된 권한을 관리하는 권한 서비스에 대한 참조를 제공합니다. 각 권한에는 사용자 또는 그룹, 역할 및 오브젝트에 대한 링크가 포함되어 있습니다. 예를 들어 특정 가상 머신에 할당된 권한을 다음과 같이 요청을 보낼 수 있습니다.

GET /ovirt-engine/api/vms/123/permissions

응답 본문은 다음과 같습니다.

<permissions>
  <permission id="456" href="/ovirt-engien/api/vms/123/permissions/456">
    <user id="789" href="/ovirt-engine/api/users/789"/>
    <role id="abc" href="/ovirt-engine/api/roles/abc"/>
    <vm id="123" href="/ovirt-engine/api/vms/123"/>
  </permission>
  ...
</permissions>

이 서비스에 권한 표현이 있는 POST 요청을 보내는 오브젝트에 권한이 추가됩니다. 각각의 새 권한에는 역할과 사용자가 필요합니다.

3.10. 오류 처리

일부 오류는 표준 HTTP 상태 코드 이외의 추가 설명이 필요합니다. 예를 들어 API는 응답 본문에서 오류가 있는 실패한 오브젝트 상태 업데이트 또는 작업을 보고합니다. 오류에는 이유세부 정보가 포함됩니다. 예를 들어 서버가 필수 이름 특성 없이 가상 시스템을 생성하는 요청을 수신하면 다음 HTTP 응답 행으로 응답합니다.

HTTP/1.1 400 Bad Request

다음 응답 본문:

<fault>
  <reason>Incomplete parameters</reason>
  <detail>Vm [name] required for add</detail>
</fault>

4장. 빠른 시작 예

이 섹션의 예제에서는 REST API를 사용하여 기본 Red Hat Virtualization 환경을 설정하고 가상 머신을 생성하는 방법을 보여줍니다. 표준 사전 요구 사항 외에도 다음 예제를 수행해야 합니다.

  • 네트워크 및 구성된 Red Hat Virtualization 설치.
  • 설치할 가상 머신 운영 체제가 포함된 ISO 파일입니다. 이 장에서는 설치 ISO 예제에 CentOS 7을 사용합니다.

API 예제에서는 curl 을 사용하여 클라이언트 애플리케이션으로 API 요청을 보여줍니다. HTTP 요청을 보내는 모든 애플리케이션을 사용할 수 있습니다.

중요

이 예제의 HTTP 요청 헤더는 HostAuthorization 헤더를 생략합니다. 그러나 이러한 필드는 필수이며 Red Hat Virtualization 설치와 관련된 데이터가 필요합니다.

curl 예제에서는 사용자 이름으로 admin@internal, 암호에 mypassword, 인증서 위치에 /etc/pki/ovirt-engine/ca.pem, 호스트 이름으로 myengine.example.com 을 사용합니다. 해당 값을 사용자 환경에 적합한 값으로 교체해야 합니다.

Red Hat Virtualization은 각 리소스에 대한 id 속성에 대한 고유 식별자를 생성합니다. 이 예제의 식별자 코드는 Red Hat Virtualization 환경의 식별자 코드와 다릅니다.

많은 예에서 간결성을 위해 API에서 반환된 결과의 일부 속성이 생략되었습니다. 전체 특성 목록은 클러스터 참조를 참조하십시오.

4.1. 액세스 API 진입점

다음 요청에서는 API 버전 4에 대한 주요 진입점의 표시를 검색합니다.

GET /ovirt-engine/api HTTP/1.1
Version: 4
Accept: application/xml

동일한 요청이지만 Version 헤더 대신 /v4 URL 접두사를 사용합니다.

GET /ovirt-engine/api/v4 HTTP/1.1
Accept: application/xml

curl 명령을 사용하는 것과 동일한 요청:

curl \
--cacert '/etc/pki/ovirt-engine/ca.pem' \
--request GET \
--header 'Version: 4' \
--header 'Accept: application/xml' \
--user 'admin@internal:mypassword' \
https://myengine.example.com/ovirt-engine/api

결과는 Api 유형의 오브젝트입니다.

<api>
  <link href="/ovirt-engine/api/clusters" rel="clusters"/>
  <link href="/ovirt-engine/api/datacenters" rel="datacenters"/>
  ...
  <product_info>
    <name>oVirt Engine</name>
    <vendor>ovirt.org</vendor>
    <version>
      <build>0</build>
      <full_version>4.0.0-0.0.el7</full_version>
      <major>4</major>
      <minor>0</minor>
      <revision>0</revision>
    </version>
  </product_info>
  <special_objects>
    <blank_template href="..." id="..."/>
    <root_tag href="..." id="..."/>
  </special_objects>
  <summary>
    <hosts>
      <active>23</active>
      <total>30</total>
    </hosts>
    <storage_domains>
      <active>5</active>
      <total>6</total>
    </storage_domains>
    <users>
      <active>12</active>
      <total>102</total>
    </users>
    <vms>
      <active>253</active>
      <total>545</total>
    </vms>
  </summary>
  <time>2016-10-06T15:38:18.548+02:00</time>
</api>
중요

헤더와 URL 접두사가 모두 사용되지 않으면 서버에서 버전을 자동으로 선택합니다. 기본값은 4 입니다. ENGINE_API_DEFAULT_VERSION 구성 매개변수를 사용하여 기본 버전을 변경할 수 있습니다.

# echo "ENGINE_API_DEFAULT_VERSION=3" > \
/etc/ovirt-engine/engine.conf.d/99-set-default-version.conf
# systemctl restart ovirt-engine

이 매개변수를 변경하면 버전을 명시적으로 지정하지 않는 API의 모든 사용자에게 영향을 미칩니다.

진입점은 가상화 환경의 컬렉션에 대한 링크를 사용자에게 제공합니다. 각 컬렉션 링크의 rel 속성은 각 링크에 대한 참조 지점을 제공합니다. 이 예제의 다음 단계에서는 datacenter 링크를 통해 사용할 수 있는 데이터 센터 컬렉션을 검사합니다.

진입점에는 product_info,special_objects요약 과 같은 기타 데이터도 포함됩니다. 이 데이터는 이 예제 외부의 장에서는 다룹니다.

4.2. 데이터 센터 나열

Red Hat Virtualization은 설치에 Default 데이터 센터를 생성합니다. 이 예에서는 Default 데이터 센터를 가상 환경의 기반으로 사용합니다.

다음 요청에서는 데이터 센터의 표현을 검색합니다.

GET /ovirt-engine/api/datacenters HTTP/1.1
Accept: application/xml

curl 명령을 사용하는 것과 동일한 요청:

# curl \
--cacert '/etc/pki/ovirt-engine/ca.pem' \
--request GET \
--header 'Version: 4' \
--header 'Accept: application/xml' \
--user 'admin@internal:mypassword' \
https://myengine.example.com/ovirt-engine/api/datacenters

결과는 DataCenter: 유형의 오브젝트 목록이 됩니다.

<data_centers>
  <data_center href="/ovirt-engine/api/datacenters/001" id="001">
    <name>Default</name>
    <description>The default Data Center</description>
    <link href="/ovirt-engine/api/datacenters/001/clusters" rel="clusters"/>
    <link href="/ovirt-engine/api/datacenters/001/storagedomains" rel="storagedomains"/>
    ...
    <local>false</local>
    <quota_mode>disabled</quota_mode>
    <status>up</status>
    <supported_versions>
      <version>
        <major>4</major>
        <minor>0</minor>
      </version>
    </supported_versions>
    <version>
      <major>4</major>
      <minor>0</minor>
    </version>
  </data_center>
  ...
</data_centers>

Default 데이터 센터의 id 를 기록해 둡니다. 가상 환경의 다른 리소스와 관련하여 이 데이터 센터를 식별합니다.

데이터 센터에는 데이터 센터에 연결된 스토리지 도메인을 관리하는 서비스에 대한 링크도 포함되어 있습니다.

<link href="/ovirt-engine/api/datacenters/001/storagedomains" rel="storagedomains"/>

해당 서비스는 기본 storagedomains 컬렉션에서 스토리지 도메인을 연결하는 데 사용됩니다. 이 예제에서는 나중에 설명합니다.

4.3. 호스트 클러스터 나열

Red Hat Virtualization은 설치에 기본 호스트 클러스터를 생성합니다. 이 예에서는 Default 클러스터를 사용하여 Red Hat Virtualization 환경의 리소스를 그룹화합니다.

다음 요청에서는 클러스터 컬렉션의 표시를 검색합니다.

GET /ovirt-engine/api/clusters HTTP/1.1
Accept: application/xml

curl 명령을 사용하는 것과 동일한 요청:

curl \
--cacert '/etc/pki/ovirt-engine/ca.pem' \
--request GET \
--header 'Version: 4' \
--header 'Accept: application/xml' \
--user 'admin@internal:mypassword' \
https://myengine.example.com/ovirt-engine/api/clusters

결과는 Cluster: 유형의 오브젝트 목록이 됩니다.

<clusters>
  <cluster href="/ovirt-engine/api/clusters/002" id="002">
    <name>Default</name>
    <description>The default server cluster</description>
    <link href="/ovirt-engine/api/clusters/002/networks" rel="networks"/>
    <link href="/ovirt-engine/api/clusters/002" rel="permissions"/>
    ...
    <cpu>
      <architecture>x86_64</architecture>
      <type>Intel Nehalem Family</type>
    </cpu>
    <version>
      <major>4</major>
      <minor>0</minor>
    </version>
    <data_center href="/ovirt-engine/api/datacenters/001" id="001"/>
  </cluster>
  ...
</clusters>

Default 호스트 클러스터의 ID 를 기록해 둡니다. 가상 환경의 다른 리소스와 관련하여 이 호스트 클러스터를 식별합니다.

Default 클러스터는 data_center 링크의 idhref 속성을 사용하는 관계를 통해 Default 데이터 센터와 연결됩니다.

<data_center href="/ovirt-engine/api/datacenters/001" id="001"/>

네트워크 링크는 이 클러스터와 연결된 네트워크를 관리하는 서비스에 대한 참조입니다. 다음 섹션에서는 networks 컬렉션을 자세히 살펴봅니다.

4.4. 논리적 네트워크 나열

Red Hat Virtualization은 설치에 기본 trusted CA 네트워크를 생성합니다. 이 네트워크는 Red Hat Virtualization Manager의 관리 네트워크 역할을 하여 호스트에 액세스합니다.

이 네트워크는 Default 클러스터와 연결되며 Default 데이터 센터의 멤버입니다. 이 예에서는 trusted CA 네트워크를 사용하여 가상 머신을 연결합니다.

다음 요청에서는 논리적 네트워크 목록을 검색합니다.

GET /ovirt-engine/api/networks HTTP/1.1
Accept: application/xml

curl 명령을 사용하는 것과 동일한 요청:

# curl \
--cacert '/etc/pki/ovirt-engine/ca.pem' \
--request GET \
--header 'Version: 4' \
--header 'Accept: application/xml' \
--user 'admin@internal:mypassword' \
https://myengine.example.com/ovirt-engine/api/networks

결과는 Network 유형의 오브젝트 목록이 됩니다.

<networks>
  <network href="/ovirt-engine/api/networks/003" id="003">
    <name>ovirtmgmt</name>
    <description>Management Network</description>
    <link href="/ovirt-engine/api/networks/003/permissions" rel="permissions"/>
    <link href="/ovirt-engine/api/networks/003/vnicprofiles" rel="vnicprofiles"/>
    <link href="/ovirt-engine/api/networks/003/networklabels" rel="networklabels"/>
    <mtu>0</mtu>
    <stp>false</stp>
    <usages>
      <usage>vm</usage>
    </usages>
    <data_center href="/ovirt-engine/api/datacenters/001" id="001"/>
  </network>
  ...
</networks>

Egress IP 네트워크는 데이터 센터의 ID를 사용하여 관계를 통해 Default 데이터 센터에 연결됩니다.

Egress IP 네트워크는 클러스터의 네트워크 하위 수집 관계를 통해 Default 클러스터에도 연결되어 있습니다.

4.5. 호스트 나열

이 예제에서는 호스트 목록을 검색하고 가상화 환경에 등록된 myhost 라는 호스트를 표시합니다.

GET /ovirt-engine/api/hosts HTTP/1.1
Accept: application/xml

curl 명령을 사용하는 것과 동일한 요청:

# curl \
--cacert '/etc/pki/ovirt-engine/ca.pem' \
--request GET \
--header 'Version: 4' \
--header 'Accept: application/xml' \
--user 'admin@internal:mypassword' \
https://myengine.example.com/ovirt-engine/api/hosts

결과는 Host: 유형의 오브젝트 목록이 됩니다.

<hosts>
  <host href="/ovirt-engine/api/hosts/004" id="004">
    <name>myhost</name>
    <link href="/ovirt-engine/api/hosts/004/nics" rel="nics"/>
    ...
    <address>node40.example.com</address>
    <cpu>
      <name>Intel Core Processor (Haswell, no TSX)</name>
      <speed>3600</speed>
      <topology>
        <cores>1</cores>
        <sockets>2</sockets>
        <threads>1</threads>
      </topology>
    </cpu>
    <memory>8371830784</memory>
    <os>
      <type>RHEL</type>
      <version>
        <full_version>7 - 2.1511.el7.centos.2.10</full_version>
        <major>7</major>
      </version>
    </os>
    <port>54321</port>
    <status>up</status>
    <cluster href="/ovirt-engine/api/clusters/002" id="002"/>
  </host>
  ...
</hosts>

호스트 ID 를 기록해 둡니다. 가상 환경의 다른 리소스와 관련하여 이 호스트를 식별합니다.

이 호스트는 Default 클러스터의 멤버이며 nics 하위 수집에 액세스하면 이 호스트가Forwarded 네트워크에 연결되어 있음을 보여줍니다.

4.6. NFS 데이터 스토리지 생성

NFS 데이터 스토리지 도메인은 데이터 센터에 연결된 내보낸 NFS 공유이며 가상화된 게스트 이미지용 스토리지를 제공합니다. 새 스토리지 도메인을 생성하려면 스토리지 도메인 표현이 포함된 POST 요청이 필요하며 스토리지 도메인 컬렉션의 URL로 전송됩니다.

기본적으로 스토리지 도메인에서 삭제 옵션을 삭제한 후 초기화를 활성화할 수 있습니다. POST 요청에 wipe_after_delete 를 지정하려면 다음을 실행합니다. 이 옵션은 도메인이 생성된 후 편집할 수 있지만 이미 존재하는 디스크의 삭제 속성 후에는 초기화되지 않습니다.

요청은 다음과 같아야 합니다.

POST /ovirt-engine/api/storagedomains HTTP/1.1
Accept: application/xml
Content-type: application/xml

요청 본문은 다음과 같아야 합니다.

<storage_domain>
  <name>mydata</name>
  <type>data</type>
  <description>My data</description>
  <storage>
    <type>nfs</type>
    <address>mynfs.example.com</address>
    <path>/exports/mydata</path>
  </storage>
  <host>
    <name>myhost</name>
  </host>
</storage_domain>

curl 명령을 사용하는 것과 동일한 요청:

# curl \
--cacert '/etc/pki/ovirt-engine/ca.pem' \
--user 'admin@internal:mypassword' \
--request POST \
--header 'Version: 4' \
--header 'Content-Type: application/xml' \
--header 'Accept: application/xml' \
--data '
<storage_domain>
  <name>mydata</name>
  <description>My data</description>
  <type>data</type>
  <storage>
    <type>nfs</type>
    <address>mynfs.example.com</address>
    <path>/exports/mydata</path>
  </storage>
  <host>
    <name>myhost</name>
  </host>
</storage_domain>
' \
https://myengine.example.com/ovirt-engine/api/storagedomains

서버는 호스트 myhost 를 사용하여 mynfs.example.com:/exports/ mydata 의 내보내기 경로를 사용하여 mydata라는 NFS 데이터 스토리지 도메인을 생성합니다. API는 새로 생성된 스토리지 도메인 리소스(스토리지 Domain유형)의 다음 표현도 반환합니다.

<storage_domain href="/ovirt-engine/api/storagedomains/005" id="005">
  <name>mydata</name>
  <description>My data</description>
  <available>42949672960</available>
  <committed>0</committed>
  <master>false</master>
  <status>unattached</status>
  <storage>
    <address>mynfs.example.com</address>
    <path>/exports/mydata</path>
    <type>nfs</type>
  </storage>
  <storage_format>v3</storage_format>
  <type>data</type>
  <used>9663676416</used>
</storage_domain>

4.7. NFS ISO 스토리지 생성

NFS ISO 스토리지 도메인은 데이터 센터에 연결된 마운트된 NFS 공유이며 DVD/CD-ROM ISO 및 VFD(가상 플로피 디스크) 이미지 파일에 대한 스토리지를 제공합니다. 새 스토리지 도메인을 생성하려면 스토리지 도메인 컬렉션의 URL로 전송된 스토리지 도메인 표현이 포함된 POST 요청이 필요합니다.

요청은 다음과 같아야 합니다.

POST /ovirt-engine/api/storagedomains HTTP/1.1
Accept: application/xml
Content-type: application/xml

요청 본문은 다음과 같아야 합니다.

<storage_domain>
  <name>myisos</name>
  <description>My ISOs</description>
  <type>iso</type>
  <storage>
    <type>nfs</type>
    <address>mynfs.example.com</address>
    <path>/exports/myisos</path>
  </storage>
  <host>
    <name>myhost</name>
  </host>
</storage_domain>

curl 명령을 사용하는 것과 동일한 요청:

# curl \
--cacert '/etc/pki/ovirt-engine/ca.pem' \
--user 'admin@internal:mypassword' \
--request POST \
--header 'Version: 4' \
--header 'Content-Type: application/xml' \
--header 'Accept: application/xml' \
--data '
<storage_domain>
  <name>myisos</name>
  <description>My ISOs</description>
  <type>iso</type>
  <storage>
    <type>nfs</type>
    <address>mynfs.example.com</address>
    <path>/exports/myisos</path>
  </storage>
  <host>
    <name>myhost</name>
  </host>
</storage_domain>
' \
https://myengine.example.com/ovirt-engine/api/storagedomains

서버는 호스트 myhost 를 사용하여 mynfs.example.com:/exports/ myisos 의 내보내기 경로를 사용하여 myisos라는 NFS ISO 스토리지 도메인을 생성합니다. API는 새로 생성된 스토리지 도메인 리소스(스토리지 Domain유형)의 다음 표현도 반환합니다.

<storage_domain href="/ovirt-engine/api/storagedomains/006" id="006">
  <name>myiso</name>
  <description>My ISOs</description>
  <available>42949672960</available>
  <committed>0</committed>
  <master>false</master>
  <status>unattached</status>
  <storage>
    <address>mynfs.example.com</address>
    <path>/exports/myisos</path>
    <type>nfs</type>
  </storage>
  <storage_format>v1</storage_format>
  <type>iso</type>
  <used>9663676416</used>
</storage_domain>

4.8. 데이터 센터에 스토리지 도메인 연결

다음 예제에서는 mydatamyisos 스토리지 도메인을 Default 데이터 센터에 연결합니다.

mydata 스토리지 도메인을 연결하려면 다음과 같은 요청을 보냅니다.

POST /ovirt-engine/api/datacenters/001/storagedomains HTTP/1.1
Accept: application/xml
Content-type: application/xml

다음과 같이 요청 본문이 있는 경우:

<storage_domain>
  <name>mydata</name>
</storage_domain>

curl 명령을 사용하는 것과 동일한 요청:

# curl \
--cacert '/etc/pki/ovirt-engine/ca.pem' \
--user 'admin@internal:mypassword' \
--request POST \
--header 'Version: 4' \
--header 'Content-Type: application/xml' \
--header 'Accept: application/xml' \
--data '
<storage_domain>
  <name>mydata</name>
</storage_domain>
' \
https://myengine.example.com/ovirt-engine/api/datacenters/001/storagedomains

myisos 스토리지 도메인을 연결하려면 다음과 같은 요청을 보냅니다.

POST /ovirt-engine/api/datacenters/001/storagedomains HTTP/1.1
Accept: application/xml
Content-type: application/xml

다음과 같이 요청 본문이 있는 경우:

<storage_domain>
  <name>myisos</name>
</storage_domain>

curl 명령을 사용하는 것과 동일한 요청:

# curl \
--cacert '/etc/pki/ovirt-engine/ca.pem' \
--user 'admin@internal:mypassword' \
--request POST \
--header 'Version: 4' \
--header 'Content-Type: application/xml' \
--header 'Accept: application/xml' \
--data '
<storage_domain>
  <name>myisos</name>
</storage_domain>
' \
https://myengine.example.com/ovirt-engine/api/datacenters/001/storagedomains

4.9. 가상 머신 생성

다음 예제에서는 가상화 환경의 Blank 템플릿을 기본으로 사용하여 Default 클러스터에 myvm 이라는 가상 시스템을 생성합니다. 요청은 가상 시스템의 메모리도 512MiB로 정의하고 부팅 장치를 가상 하드 디스크로 설정합니다.

요청에는 생성할 가상 머신을 설명하는 Vm 유형의 오브젝트가 포함되어야 합니다.

POST /ovirt-engine/api/vms HTTP/1.1
Accept: application/xml
Content-type: application/xml

요청 본문은 다음과 같아야 합니다.

<vm>
  <name>myvm</name>
  <description>My VM</description>
  <cluster>
    <name>Default</name>
  </cluster>
  <template>
    <name>Blank</name>
  </template>
  <memory>536870912</memory>
  <os>
    <boot>
      <devices>
        <device>hd</device>
      </devices>
    </boot>
  </os>
</vm>

curl 명령을 사용하는 것과 동일한 요청:

# curl \
--cacert '/etc/pki/ovirt-engine/ca.pem' \
--user 'admin@internal:mypassword' \
--request POST \
--header 'Version: 4' \
--header 'Content-Type: application/xml' \
--header 'Accept: application/xml' \
--data '
<vm>
  <name>myvm</name>
  <description>My VM</description>
  <cluster>
    <name>Default</name>
  </cluster>
  <template>
    <name>Blank</name>
  </template>
  <memory>536870912</memory>
  <os>
    <boot>
      <devices>
        <device>hd</device>
      </devices>
    </boot>
  </os>
</vm>
' \
https://myengine.example.com/ovirt-engine/api/vms

응답 본문은 Vm 유형의 객체가 될 것입니다:

<vm href="/ovirt-engine/api/vms/007" id="007">
  <name>myvm</name>
  <link href="/ovirt-engine/api/vms/007/diskattachments" rel="diskattachments"/>
  <link href="/ovirt-engine/api/vms/007/nics" rel="nics"/>
  ...
  <cpu>
    <architecture>x86_64</architecture>
    <topology>
      <cores>1</cores>
      <sockets>1</sockets>
      <threads>1</threads>
    </topology>
  </cpu>
  <memory>1073741824</memory>
  <os>
    <boot>
      <devices>
        <device>hd</device>
      </devices>
    </boot>
    <type>other</type>
  </os>
  <type>desktop</type>
  <cluster href="/ovirt-engine/api/clusters/002" id="002"/>
  <status>down</status>
  <original_template href="/ovirt-engine/api/templates/000" id="00"/>
  <template href="/ovirt-engine/api/templates/000" id="000"/>
</vm>

4.10. 가상 머신 NIC 생성

다음 예제에서는 예제 가상 시스템을 ovirtmgmt 네트워크에 연결하는 가상 네트워크 인터페이스를 생성합니다.

요청은 다음과 같아야 합니다.

POST /ovirt-engine/api/vms/007/nics HTTP/1.1
Content-Type: application/xml
Accept: application/xml

요청 본문에는 생성할 NIC를 설명하는 Nic 유형의 오브젝트가 포함되어야 합니다.

<nic>
  <name>mynic</name>
  <description>My network interface card</description>
</nic>

curl 명령을 사용하는 것과 동일한 요청:

# curl \
--cacert '/etc/pki/ovirt-engine/ca.pem' \
--user 'admin@internal:mypassword' \
--request POST \
--header 'Version: 4' \
--header 'Content-Type: application/xml' \
--header 'Accept: application/xml' \
--data '
<nic>
  <name>mynic</name>
  <description>My network interface card</description>
</nic>
' \
https://myengine.example.com/ovirt-engine/api/vms/007/nics

4.11. 가상 머신 디스크 생성

다음 예제에서는 예제 가상 시스템에 대해 8GiB COW(Copy-On-Write ) 디스크를 생성합니다.

요청은 다음과 같아야 합니다.

POST /ovirt-engine/api/vms/007/diskattachments HTTP/1.1
Content-Type: application/xml
Accept: application/xml

요청 본문은 디스크 및 가상 머신에 연결하는 방법을 설명하는 DiskAttachment 유형의 오브젝트여야 합니다.

<disk_attachment>
  <bootable>false</bootable>
  <interface>virtio</interface>
  <active>true</active>
  <disk>
    <description>My disk</description>
    <format>cow</format>
    <name>mydisk</name>
    <provisioned_size>8589934592</provisioned_size>
    <storage_domains>
      <storage_domain>
        <name>mydata</name>
      </storage_domain>
    </storage_domains>
  </disk>
</disk_attachment>

curl 명령을 사용하는 것과 동일한 요청:

# curl \
--cacert '/etc/pki/ovirt-engine/ca.pem' \
--user 'admin@internal:mypassword' \
--request POST \
--header 'Version: 4' \
--header 'Content-Type: application/xml' \
--header 'Accept: application/xml' \
--data '
<disk_attachment>
  <bootable>false</bootable>
  <interface>virtio</interface>
  <active>true</active>
  <disk>
    <description>My disk</description>
    <format>cow</format>
    <name>mydisk</name>
    <provisioned_size>8589934592</provisioned_size>
    <storage_domains>
      <storage_domain>
        <name>mydata</name>
      </storage_domain>
    </storage_domains>
  </disk>
</disk_attachment>
' \
https://myengine.example.com/ovirt-engine/api/vms/007/diskattachments

storage_domains 특성은 API에 mydata 스토리지 도메인에 디스크를 저장하도록 지시합니다.

4.12. 가상 머신에 ISO 이미지 연결

다음 가상 시스템 예의 부트 미디어에는 운영 체제 설치를 위해 CD-ROM 또는 DVD ISO 이미지가 필요합니다. 이 예제에서는 CentOS 7 이미지를 사용합니다.

가상 시스템이 사용할 수 있도록 ISO 이미지는 myisos ISO 도메인에서 사용할 수 있어야 합니다. ImageTransfer 를 사용하여 이미지 전송을 생성하고 ImageTransfers 를 사용하여 ISO 이미지를 업로드할 수 있습니다.

ISO 이미지가 업로드되면 API를 사용하여 ISO 스토리지 도메인에서 파일 목록을 요청할 수 있습니다.

GET /ovirt-engine/api/storagedomains/006/files HTTP/1.1
Accept: application/xml

curl 명령을 사용하는 것과 동일한 요청:

# curl \
--cacert '/etc/pki/ovirt-engine/ca.pem' \
--user 'admin@internal:mypassword' \
--request GET \
--header 'Version: 4' \
--header 'Accept: application/xml' \
https://myengine.example.com/ovirt-engine/api/storagedomains/006/files

서버는 사용 가능한 ISO (또는 플로피) 이미지에 대해 File 유형의 다음 목록을 반환합니다.

<files>
  <file href="..." id="CentOS-7-x86_64-Minimal.iso">
    <name>CentOS-7-x86_64-Minimal.iso</name>
  </file>
  ...
</files>

API 사용자는 CentOS-7-x86_64-Minimal.iso 를 예제 가상 머신에 연결합니다. ISO 이미지를 연결하는 것은 관리 또는 사용자 포털 애플리케이션의 Change CD 버튼을 사용하는 것과 동일합니다.

요청은 다음과 같아야 합니다.

PUT /ovirt-engine/api/vms/007/cdroms/00000000-0000-0000-0000-000000000000 HTTP/1.1
Accept: application/xml
Content-type: application/xml

요청 본문은 ISO(또는 플로피) 이미지의 식별자를 나타내기 위해 내부 파일 속성을 포함하는 Cdrom 유형의 오브젝트여야 합니다.

<cdrom>
  <file id="CentOS-7-x86_64-Minimal.iso"/>
</cdrom>

curl 명령을 사용하는 것과 동일한 요청:

# curl \
--cacert '/etc/pki/ovirt-engine/ca.pem' \
--user 'admin@internal:mypassword' \
--request PUT \
--header 'Version: 4' \
--header 'Content-Type: application/xml' \
--header 'Accept: application/xml' \
--data '
<cdrom>
  <file id="CentOS-7-x86_64-Minimal.iso"/>
</cdrom>
' \
https://myengine.example.com/ovirt-engine/api/vms/007/cdroms/00000000-0000-0000-0000-000000000000

자세한 내용은 가상 머신 CD-ROMS를 관리하는 서비스 설명서를 참조하십시오.

4.13. 가상 머신 시작

가상 환경이 완료되고 가상 머신에는 작동하는 데 필요한 모든 구성 요소가 포함되어 있습니다. 이 예에서는 start 방법을 사용하여 가상 시스템을 시작합니다.

요청은 다음과 같아야 합니다.

POST /ovirt-engine/api/vms/007/start HTTP/1.1
Accept: application/xml
Content-type: application/xml

요청 본문은 다음과 같아야 합니다.

<action>
  <vm>
    <os>
      <boot>
        <devices>
          <device>cdrom</device>
        </devices>
      </boot>
    </os>
  </vm>
</action>

curl 명령을 사용하는 것과 동일한 요청:

# curl \
--cacert '/etc/pki/ovirt-engine/ca.pem' \
--user 'admin@internal:mypassword' \
--request POST \
--header 'Version: 4' \
--header 'Content-Type: application/xml' \
--header 'Accept: application/xml' \
--data '
<action>
  <vm>
    <os>
      <boot>
        <devices>
          <device>cdrom</device>
        </devices>
      </boot>
    </os>
  </vm>
</action>
' \
https://myengine.example.com/ovirt-engine/api/vms/007/start

추가 요청 본문은 이 부팅 시에만 가상 머신의 부팅 장치를 CD-ROM으로 설정합니다. 그러면 가상 머신에서 연결된 ISO 이미지에서 운영 체제를 설치할 수 있습니다. 부팅 장치는 향후 모든 부팅을 위해 디스크로 되돌립니다.

5장. 요구 사항

이 섹션에서는 API에서 사용할 수 있는 모든 요청을 열거합니다.

6장. 서비스

이 섹션에서는 API에서 사용할 수 있는 모든 서비스를 열거합니다.

6.1. AffinityGroup

이 서비스는 단일 선호도 그룹을 관리합니다.

Expand
표 6.1. 메서드 요약
이름요약

get

선호도 그룹 세부 정보를 검색합니다.

제거

선호도 그룹을 제거합니다.

update

선호도 그룹을 업데이트합니다.

6.1.1. GET가져오기

선호도 그룹 세부 정보를 검색합니다.

<affinity_group id="00000000-0000-0000-0000-000000000000">
  <name>AF_GROUP_001</name>
  <cluster id="00000000-0000-0000-0000-000000000000"/>
  <positive>true</positive>
  <enforcing>true</enforcing>
</affinity_group>
Expand
표 6.2. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

group

AffinityGroup

Out

선호도 그룹.

6.1.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.1.2. DELETE제거

선호도 그룹을 제거합니다.

DELETE /ovirt-engine/api/clusters/000-000/affinitygroups/123-456
Expand
표 6.3. 매개변수 요약
이름유형방향요약

async

부울

in

제거를 비동기적으로 수행해야 하는지 여부를 나타냅니다.Indicates if the removal should be performed asynchronously.

6.1.3. PUT업데이트

선호도 그룹을 업데이트합니다.

Expand
표 6.4. 매개변수 요약
이름유형방향요약

async

부울

in

업데이트를 비동기적으로 수행해야 하는지 여부를 나타냅니다.

group

AffinityGroup

in/Out

선호도 그룹.

6.2. AffinityGroupHost

이 서비스는 단일 호스트를 선호도 그룹 할당에 관리합니다.

Expand
표 6.5. 메서드 요약
이름요약

제거

선호도 그룹에서 호스트를 제거합니다.

6.2.1. DELETE제거

선호도 그룹에서 호스트를 제거합니다.

Expand
표 6.6. 매개변수 요약
이름유형방향요약

async

부울

in

제거를 비동기적으로 수행해야 하는지 여부를 나타냅니다.Indicates if the removal should be performed asynchronously.

6.3. AffinityGroupHostLabel

이 서비스는 선호도 그룹에 할당된 단일 호스트 레이블을 관리합니다.

Expand
표 6.7. 메서드 요약
이름요약

제거

선호도 그룹에서 이 레이블을 제거합니다.

6.3.1. DELETE제거

선호도 그룹에서 이 레이블을 제거합니다.

Expand
표 6.8. 매개변수 요약
이름유형방향요약

async

부울

in

제거를 비동기적으로 수행해야 하는지 여부를 나타냅니다.Indicates if the removal should be performed asynchronously.

6.4. AffinityGroupHostLabels

이 서비스는 선호도 그룹에 할당된 모든 호스트 레이블의 컬렉션을 관리합니다.

Expand
표 6.9. 메서드 요약
이름요약

add

선호도 그룹에 호스트 레이블을 추가합니다.

list

이 선호도 그룹에 할당된 모든 호스트 레이블을 나열합니다.

6.4.1. POST추가

선호도 그룹에 호스트 레이블을 추가합니다.

예를 들어 레이블 789 를 클러스터 123 의 선호도 그룹 456 에 추가하려면 다음과 같은 요청을 보냅니다.

POST /ovirt-engine/api/clusters/123/affinitygroups/456/hostlabels

다음 본문으로:

<affinity_label id="789"/>
Expand
표 6.10. 매개변수 요약
이름유형방향요약

label

AffinityLabel

in/Out

유사성 그룹에 추가할 AffinityLabel 오브젝트입니다.

6.4.2. GET나열

이 선호도 그룹에 할당된 모든 호스트 레이블을 나열합니다.

반환된 레이블의 순서는 보장되지 않습니다.

Expand
표 6.11. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

labels

AffinityLabel[]

Out

선호도 그룹에 할당된 호스트 레이블입니다.

max

정수

in

반환할 최대 호스트 레이블 수를 설정합니다.

6.4.2.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.4.2.2. max

반환할 최대 호스트 레이블 수를 설정합니다. 지정하지 않으면 모든 라벨이 반환됩니다.

6.5. AffinityGroupHosts

이 서비스는 선호도 그룹에 할당된 모든 호스트의 컬렉션을 관리합니다.

Expand
표 6.12. 메서드 요약
이름요약

add

선호도 그룹에 호스트를 추가합니다.

list

이 선호도 그룹에 할당된 모든 호스트를 나열합니다.

6.5.1. POST추가

선호도 그룹에 호스트를 추가합니다.

예를 들어 호스트 789 를 클러스터 123 의 선호도 그룹 456 에 추가하려면 다음과 같은 요청을 보냅니다.

POST /ovirt-engine/api/clusters/123/affinitygroups/456/hosts

다음 본문으로:

<host id="789"/>
Expand
표 6.13. 매개변수 요약
이름유형방향요약

host

호스트

in/Out

선호도 그룹에 추가할 호스트입니다.

6.5.2. GET나열

이 선호도 그룹에 할당된 모든 호스트를 나열합니다.

반환된 호스트의 순서는 보장되지 않습니다.

Expand
표 6.14. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

호스트

Host[]

Out

이 선호도 그룹에 할당된 호스트 목록입니다.

max

정수

in

반환할 최대 호스트 수를 설정합니다.

6.5.2.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.5.2.2. max

반환할 최대 호스트 수를 설정합니다. 지정하지 않으면 모든 호스트가 반환됩니다.

6.6. AffinityGroupVm

이 서비스는 단일 가상 머신을 선호도 그룹 할당에 관리합니다.

Expand
표 6.15. 메서드 요약
이름요약

제거

선호도 그룹에서 이 가상 머신을 제거합니다.

6.6.1. DELETE제거

선호도 그룹에서 이 가상 머신을 제거합니다.

Expand
표 6.16. 매개변수 요약
이름유형방향요약

async

부울

in

제거를 비동기적으로 수행해야 하는지 여부를 나타냅니다.Indicates if the removal should be performed asynchronously.

6.7. AffinityGroupVmLabel

이 서비스는 선호도 그룹에 할당된 단일 가상 머신 레이블을 관리합니다.

Expand
표 6.17. 메서드 요약
이름요약

제거

선호도 그룹에서 이 레이블을 제거합니다.

6.7.1. DELETE제거

선호도 그룹에서 이 레이블을 제거합니다.

Expand
표 6.18. 매개변수 요약
이름유형방향요약

async

부울

in

제거를 비동기적으로 수행해야 하는지 여부를 나타냅니다.Indicates if the removal should be performed asynchronously.

6.8. AffinityGroupVmLabels

이 서비스는 선호도 그룹에 할당된 모든 가상 머신 레이블의 컬렉션을 관리합니다.

Expand
표 6.19. 메서드 요약
이름요약

add

선호도 그룹에 가상 머신 라벨을 추가합니다.

list

이 선호도 그룹에 할당된 모든 가상 머신 레이블을 나열합니다.

6.8.1. POST추가

선호도 그룹에 가상 머신 라벨을 추가합니다.

예를 들어 레이블 789 를 클러스터 123 의 선호도 그룹 456 에 추가하려면 다음과 같은 요청을 보냅니다.

POST /ovirt-engine/api/clusters/123/affinitygroups/456/vmlabels

다음 본문으로:

<affinity_label id="789"/>
Expand
표 6.20. 매개변수 요약
이름유형방향요약

label

AffinityLabel

in/Out

유사성 그룹에 추가할 AffinityLabel 오브젝트입니다.

6.8.2. GET나열

이 선호도 그룹에 할당된 모든 가상 머신 레이블을 나열합니다.

반환된 레이블의 순서는 보장되지 않습니다.

Expand
표 6.21. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

labels

AffinityLabel[]

Out

선호도 그룹에 할당된 가상 머신 레이블입니다.

max

정수

in

반환할 최대 가상 머신 레이블 수를 설정합니다.

6.8.2.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.8.2.2. max

반환할 최대 가상 머신 레이블 수를 설정합니다. 지정하지 않으면 모든 라벨이 반환됩니다.

6.9. AffinityGroupVms

이 서비스는 선호도 그룹에 할당된 모든 가상 시스템의 컬렉션을 관리합니다.

Expand
표 6.22. 메서드 요약
이름요약

add

선호도 그룹에 가상 머신을 추가합니다.

list

이 선호도 그룹에 할당된 모든 가상 머신을 나열합니다.

6.9.1. POST추가

선호도 그룹에 가상 머신을 추가합니다.

예를 들어 가상 머신(7989) 클러스터 123 의 선호도 그룹 456 에 추가하려면 다음과 같은 요청을 보냅니다.

POST /ovirt-engine/api/clusters/123/affinitygroups/456/vms

다음 본문으로:

<vm id="789"/>
Expand
표 6.23. 매개변수 요약
이름유형방향요약

vm

Vm

in/Out

 

6.9.2. GET나열

이 선호도 그룹에 할당된 모든 가상 머신을 나열합니다.

반환된 가상 머신의 순서는 보장되지 않습니다.

Expand
표 6.24. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 최대 가상 머신 수를 설정합니다.

vms

Vm[]

Out

 
6.9.2.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.9.2.2. max

반환할 최대 가상 머신 수를 설정합니다. 지정하지 않으면 모든 가상 머신이 반환됩니다.

6.10. AffinityGroups

선호도 그룹 서비스는 가상 머신 관계 및 종속성을 관리합니다.

Expand
표 6.25. 메서드 요약
이름요약

add

새 선호도 그룹을 생성합니다.

list

기존 선호도 그룹을 나열합니다.

6.10.1. POST추가

새 선호도 그룹을 생성합니다.

새 선호도 그룹을 생성하려면 아래 예제와 같은 요청을 게시합니다.

POST /ovirt-engine/api/clusters/000-000/affinitygroups

본문에 다음 예제를 사용합니다.Use the following example in its body:

<affinity_group>
  <name>AF_GROUP_001</name>
  <hosts_rule>
    <enforcing>true</enforcing>
    <positive>true</positive>
  </hosts_rule>
  <vms_rule>
    <enabled>false</enabled>
  </vms_rule>
</affinity_group>
Expand
표 6.26. 매개변수 요약
이름유형방향요약

group

AffinityGroup

in/Out

생성할 선호도 그룹 오브젝트입니다.

6.10.2. GET나열

기존 선호도 그룹을 나열합니다.

선호도 그룹 결과 순서는 보장되지 않습니다.

Expand
표 6.27. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

groups

AffinityGroup[]

Out

기존 선호도 그룹 목록입니다.

max

정수

in

반환할 최대 선호도 그룹 수를 설정합니다.

6.10.2.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.10.2.2. max

반환할 최대 선호도 그룹 수를 설정합니다. 지정하지 않으면 모든 선호도 그룹이 반환됩니다.

6.11. AffinityLabel

단일 유사성 라벨의 세부 정보입니다.

Expand
표 6.28. 메서드 요약
이름요약

get

레이블의 세부 정보를 검색합니다.

제거

시스템에서 레이블을 제거하고 삭제된 라벨의 모든 할당을 지웁니다.

update

레이블을 업데이트합니다.

6.11.1. GET가져오기

레이블의 세부 정보를 검색합니다.

Expand
표 6.29. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

label

AffinityLabel

Out

 
6.11.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.11.2. DELETE제거

시스템에서 레이블을 제거하고 삭제된 라벨의 모든 할당을 지웁니다.

6.11.3. PUT업데이트

레이블을 업데이트합니다. 이 호출은 이름 또는 설명과 같은 모든 메타데이터를 업데이트합니다.

Expand
표 6.30. 매개변수 요약
이름유형방향요약

label

AffinityLabel

in/Out

 

6.12. AffinityLabelHost

이 서비스는 affinitylabels/hosts 하위 수집을 통해 액세스할 때 특정 레이블이 있는 호스트를 나타냅니다.

Expand
표 6.31. 메서드 요약
이름요약

get

이 레이블이 할당된 호스트에 대한 세부 정보를 검색합니다.

제거

호스트에서 레이블을 제거합니다.

6.12.1. GET가져오기

이 레이블이 할당된 호스트에 대한 세부 정보를 검색합니다.

Expand
표 6.32. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

host

호스트

Out

 
6.12.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.12.2. DELETE제거

호스트에서 레이블을 제거합니다.

6.13. AffinityLabelHosts

이 서비스는 affinitylabels/hosts 하위 컬렉션을 통해 액세스할 때 특정 레이블이 있는 호스트 목록을 나타냅니다.

Expand
표 6.33. 메서드 요약
이름요약

add

호스트에 레이블을 추가합니다.

list

레이블이 있는 모든 호스트를 나열합니다.

6.13.1. POST추가

호스트에 레이블을 추가합니다.

Expand
표 6.34. 매개변수 요약
이름유형방향요약

host

호스트

in/Out

 

6.13.2. GET나열

레이블이 있는 모든 호스트를 나열합니다.

반환된 호스트의 순서는 보장되지 않습니다.

Expand
표 6.35. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

호스트

Host[]

Out

 
6.13.2.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.14. AffinityLabelVm

이 서비스는 affinitylabels/vms 하위 수집을 통해 액세스할 때 특정 레이블이 있는 vm를 나타냅니다.

Expand
표 6.36. 메서드 요약
이름요약

get

이 레이블이 할당된 vm에 대한 세부 정보를 검색합니다.

제거

vm에서 레이블을 제거합니다.

6.14.1. GET가져오기

이 레이블이 할당된 vm에 대한 세부 정보를 검색합니다.

Expand
표 6.37. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

vm

Vm

Out

 
6.14.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.14.2. DELETE제거

vm에서 레이블을 제거합니다.

6.15. AffinityLabelVms

이 서비스는 affinitylabels/vms 하위 수집을 통해 액세스할 때 특정 레이블이 있는 vms 목록을 나타냅니다.

Expand
표 6.38. 메서드 요약
이름요약

add

vm에 레이블을 추가합니다.

list

레이블이 있는 모든 가상 머신을 나열합니다.

6.15.1. POST추가

vm에 레이블을 추가합니다.

Expand
표 6.39. 매개변수 요약
이름유형방향요약

vm

Vm

in/Out

 

6.15.2. GET나열

레이블이 있는 모든 가상 머신을 나열합니다.

반환된 가상 머신의 순서는 보장되지 않습니다.

Expand
표 6.40. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

vms

Vm[]

Out

 
6.15.2.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.16. AffinityLabels

시스템에서 사용 가능한 선호도 레이블을 관리합니다.

Expand
표 6.41. 메서드 요약
이름요약

add

새 레이블을 생성합니다.

list

시스템에 있는 모든 레이블을 나열합니다.

6.16.1. POST추가

새 레이블을 생성합니다. 레이블은 vms 또는 호스트 목록에 언급된 모든 엔터티에 자동으로 연결됩니다.

Expand
표 6.42. 매개변수 요약
이름유형방향요약

label

AffinityLabel

in/Out

 

6.16.2. GET나열

시스템에 있는 모든 레이블을 나열합니다.

반환된 레이블의 순서는 보장되지 않습니다.

Expand
표 6.43. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

labels

AffinityLabel[]

Out

 

max

정수

in

반환할 최대 레이블 수를 설정합니다.

6.16.2.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.16.2.2. max

반환할 최대 레이블 수를 설정합니다. 지정하지 않으면 모든 라벨이 반환됩니다.

6.17. 지역

이 주석은 주석이 달린 개념인 oVirt 영역을 지정하기 위한 것입니다. 현재 다음 영역이 사용 중이며 oVirt 팀과 밀접하게 연관되어 있지만 반드시 동일하지는 않습니다.

  • 인프라
  • 네트워크
  • SLA
  • 스토리지
  • 가상화

개념은 하나 이상의 영역, 또는 어떤 영역에도 연관되지 않을 수 있습니다.

이 주석의 값은 보고용으로만 사용되며 생성된 모든 코드 또는 모델의 유효성에는 영향을 미치지 않습니다.

6.18. AssignedAffinityLabel

이 서비스는 entities/affinitylabels 하위 수집을 사용하여 액세스할 때 엔터티 할당에 대한 하나의 레이블을 나타냅니다.

Expand
표 6.44. 메서드 요약
이름요약

get

연결된 레이블에 대한 세부 정보를 검색합니다.

제거

엔터티에서 레이블을 제거합니다.

6.18.1. GET가져오기

연결된 레이블에 대한 세부 정보를 검색합니다.

Expand
표 6.45. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

label

AffinityLabel

Out

 
6.18.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.18.2. DELETE제거

엔터티에서 레이블을 제거합니다. 레이블 자체를 건드리지 않습니다.

6.19. AssignedAffinityLabels

이 서비스는 entities/affinitylabels를 사용하여 액세스할 때 지원되는 엔터티에 할당된 선호도 레이블을 나열하고 조작하는 데 사용됩니다.

Expand
표 6.46. 메서드 요약
이름요약

add

레이블을 엔터티에 연결합니다.

list

엔터티에 연결된 모든 레이블을 나열합니다.

6.19.1. POST추가

레이블을 엔터티에 연결합니다.

Expand
표 6.47. 매개변수 요약
이름유형방향요약

label

AffinityLabel

in/Out

 

6.19.2. GET나열

엔터티에 연결된 모든 레이블을 나열합니다.

반환된 엔터티의 순서는 보장되지 않습니다.

Expand
표 6.48. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

label

AffinityLabel[]

Out

 
6.19.2.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.20. AssignedCpuProfile

Expand
표 6.49. 메서드 요약
이름요약

get

 

제거

 

6.20.1. GET가져오기

Expand
표 6.50. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

profile

CpuProfile

Out

 
6.20.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.20.2. DELETE제거

Expand
표 6.51. 매개변수 요약
이름유형방향요약

async

부울

in

제거가 비동기적으로 수행되어야 하는지 여부를 나타냅니다.

6.21. AssignedCpuProfiles

Expand
표 6.52. 메서드 요약
이름요약

add

클러스터의 새 cpu 프로필을 추가합니다.

list

클러스터에 할당된 CPU 프로필을 나열합니다.

6.21.1. POST추가

클러스터의 새 cpu 프로필을 추가합니다.

Expand
표 6.53. 매개변수 요약
이름유형방향요약

profile

CpuProfile

in/Out

 

6.21.2. GET나열

클러스터에 할당된 CPU 프로필을 나열합니다.

반환된 CPU 프로필의 순서는 보장되지 않습니다.

Expand
표 6.54. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 최대 프로필 수를 설정합니다.

profiles

CpuProfile[]

Out

 
6.21.2.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.21.2.2. max

반환할 최대 프로필 수를 설정합니다. 지정하지 않으면 모든 프로필이 반환됩니다.

6.22. AssignedDiskProfile

Expand
표 6.55. 메서드 요약
이름요약

get

 

제거

 

6.22.1. GET가져오기

Expand
표 6.56. 매개변수 요약
이름유형방향요약

disk_profile

DiskProfile

Out

 

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

6.22.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.22.2. DELETE제거

Expand
표 6.57. 매개변수 요약
이름유형방향요약

async

부울

in

제거가 비동기적으로 수행되어야 하는지 여부를 나타냅니다.

6.23. AssignedDiskProfiles

Expand
표 6.58. 메서드 요약
이름요약

add

스토리지 도메인의 새 디스크 프로필을 추가합니다.

list

스토리지 도메인에 할당된 디스크 프로필 목록을 반환합니다.

6.23.1. POST추가

스토리지 도메인의 새 디스크 프로필을 추가합니다.

Expand
표 6.59. 매개변수 요약
이름유형방향요약

profile

DiskProfile

in/Out

 

6.23.2. GET나열

스토리지 도메인에 할당된 디스크 프로필 목록을 반환합니다.

반환된 디스크 프로필의 순서는 보장되지 않습니다.

Expand
표 6.60. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 최대 프로필 수를 설정합니다.

profiles

DiskProfile[]

Out

 
6.23.2.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.23.2.2. max

반환할 최대 프로필 수를 설정합니다. 지정하지 않으면 모든 프로필이 반환됩니다.

6.24. AssignedPermissions

사용자, 그룹 또는 일부 엔터티 유형에 따라 범위가 지정된 권한 하위 수집을 나타냅니다.

Expand
표 6.61. 메서드 요약
이름요약

add

특정 엔터티에 대해 사용자 또는 그룹에 새 권한을 할당합니다.

list

특정 엔티티의 모든 권한을 나열합니다.

6.24.1. POST추가

특정 엔터티에 대해 사용자 또는 그룹에 새 권한을 할당합니다.

예를 들어 ID가 123 인 가상 시스템에 UserVmManager 역할을 할당하려면 ID 456 이 다음과 같은 요청을 보냅니다.

POST /ovirt-engine/api/vms/123/permissions

다음과 같이 요청 본문이 있는 경우:

<permission>
  <role>
    <name>UserVmManager</name>
  </role>
  <user id="456"/>
</permission>

id 456 이 있는 사용자에게 SuperUser 역할을 시스템에 할당하려면 다음과 같은 요청을 보냅니다.

POST /ovirt-engine/api/permissions

다음과 같이 요청 본문이 있는 경우:

<permission>
  <role>
    <name>SuperUser</name>
  </role>
  <user id="456"/>
</permission>

사용자 대신 그룹에 권한을 할당하려는 경우 사용자 요소를 그룹 요소의 적절한 ID 로 바꾸십시오. 예를 들어 id가 123 인 클러스터에 UserRole 역할을 id 789 가 있는 그룹에 할당하려면 다음과 같은 요청을 보냅니다.

POST /ovirt-engine/api/clusters/123/permissions

다음과 같이 요청 본문이 있는 경우:

<permission>
  <role>
    <name>UserRole</name>
  </role>
  <group id="789"/>
</permission>
Expand
표 6.62. 매개변수 요약
이름유형방향요약

권한

권한

in/Out

권한입니다.

6.24.2. GET나열

특정 엔티티의 모든 권한을 나열합니다.

예를 들어 ID가 123 인 클러스터의 모든 권한을 나열하려면 다음과 같은 요청을 보냅니다.

GET /ovirt-engine/api/clusters/123/permissions
<permissions>
  <permission id="456">
    <cluster id="123"/>
    <role id="789"/>
    <user id="451"/>
  </permission>
  <permission id="654">
    <cluster id="123"/>
    <role id="789"/>
    <group id="127"/>
  </permission>
</permissions>

반환된 권한의 순서는 보장되지 않습니다.

Expand
표 6.63. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

권한

승인 []

Out

권한 목록.

6.24.2.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.25. AssignedRoles

사용자 범위가 지정된 역할 수집(예: user)을 나타냅니다.

Expand
표 6.64. 메서드 요약
이름요약

list

권한에 할당된 역할을 반환합니다.

6.25.1. GET나열

권한에 할당된 역할을 반환합니다.

반환된 역할의 순서는 보장되지 않습니다.

Expand
표 6.65. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 최대 역할 수를 설정합니다.

역할

Role []

Out

 
6.25.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.25.1.2. max

반환할 최대 역할 수를 설정합니다. 지정하지 않으면 모든 역할이 반환됩니다.

6.26. AssignedTag

시스템의 특정 엔터티에 대한 특정 태그 할당을 관리하는 서비스입니다.

Expand
표 6.66. 메서드 요약
이름요약

get

할당된 태그에 대한 정보를 가져옵니다.

제거

시스템의 특정 엔티티에서 태그를 할당 해제합니다.

6.26.1. GET가져오기

할당된 태그에 대한 정보를 가져옵니다.

예를 들어 ID 123 을 사용하여 가상 머신에 할당된 ID 456 을 사용하여 태그에 대한 정보를 검색하려면 다음과 같이 요청을 보냅니다.

GET /ovirt-engine/api/vms/123/tags/456
<tag href="/ovirt-engine/api/tags/456" id="456">
  <name>root</name>
  <description>root</description>
  <vm href="/ovirt-engine/api/vms/123" id="123"/>
</tag>
Expand
표 6.67. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

tag

Tag

Out

할당된 태그입니다.

6.26.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.26.2. DELETE제거

시스템의 특정 엔티티에서 태그를 할당 해제합니다.

예를 들어 ID 123 이 있는 가상 머신에서 ID 456 으로 태그를 할당 취소하려면 다음과 같은 요청을 보냅니다.

DELETE /ovirt-engine/api/vms/123/tags/456
Expand
표 6.68. 매개변수 요약
이름유형방향요약

async

부울

in

제거가 비동기적으로 수행되어야 하는지 여부를 나타냅니다.

6.27. AssignedTags

시스템의 특정 엔터티에 태그 할당 컬렉션을 관리하는 서비스입니다.

Expand
표 6.69. 메서드 요약
이름요약

add

시스템의 특정 엔터티에 태그를 할당합니다.

list

특정 엔터티에 할당된 모든 태그를 나열합니다.

6.27.1. POST추가

시스템의 특정 엔터티에 태그를 할당합니다.

예를 들어 ID 123 으로 mytag 태그를 가상 머신에 할당하려면 다음과 같은 요청을 보냅니다.

POST /ovirt-engine/api/vms/123/tags

다음과 같이 요청 본문이 있는 경우:

<tag>
  <name>mytag</name>
</tag>
Expand
표 6.70. 매개변수 요약
이름유형방향요약

tag

Tag

in/Out

할당된 태그입니다.

6.27.2. GET나열

특정 엔터티에 할당된 모든 태그를 나열합니다.

예를 들어 ID 123 이 있는 가상 머신의 모든 태그를 나열하려면 다음과 같은 요청을 보냅니다.

GET /ovirt-engine/api/vms/123/tags
<tags>
  <tag href="/ovirt-engine/api/tags/222" id="222">
    <name>mytag</name>
    <description>mytag</description>
    <vm href="/ovirt-engine/api/vms/123" id="123"/>
  </tag>
</tags>

반환된 태그의 순서는 보장되지 않습니다.

Expand
표 6.71. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 최대 태그 수를 설정합니다.

tags

Tag[]

Out

할당된 태그 목록입니다.

6.27.2.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.27.2.2. max

반환할 최대 태그 수를 설정합니다. 지정하지 않으면 모든 태그가 반환됩니다.

6.28. AssignedVnicProfile

Expand
표 6.72. 메서드 요약
이름요약

get

 

제거

 

6.28.1. GET가져오기

Expand
표 6.73. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

profile

VnicProfile

Out

 
6.28.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.28.2. DELETE제거

Expand
표 6.74. 매개변수 요약
이름유형방향요약

async

부울

in

제거가 비동기적으로 수행되어야 하는지 여부를 나타냅니다.

6.29. AssignedVnicProfiles

Expand
표 6.75. 메서드 요약
이름요약

add

네트워크에 대한 새 가상 네트워크 인터페이스 카드 프로필을 추가합니다.

list

VNIC 프로필 목록을 네트워크에 있는 것으로 반환합니다.

6.29.1. POST추가

네트워크에 대한 새 가상 네트워크 인터페이스 카드 프로필을 추가합니다.

Expand
표 6.76. 매개변수 요약
이름유형방향요약

profile

VnicProfile

in/Out

 

6.29.2. GET나열

VNIC 프로필 목록을 네트워크에 있는 것으로 반환합니다.

반환된 VNIC 프로필의 순서는 보장되지 않습니다.

Expand
표 6.77. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 최대 프로필 수를 설정합니다.

profiles

VnicProfile[]

Out

 
6.29.2.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.29.2.2. max

반환할 최대 프로필 수를 설정합니다. 지정하지 않으면 모든 프로필이 반환됩니다.

6.30. AttachedStorageDomain

Expand
표 6.78. 메서드 요약
이름요약

activate

이 작업은 연결된 스토리지 도메인을 활성화합니다.

deactivate

이 작업은 연결된 스토리지 도메인을 비활성화합니다.

get

 

제거

 

6.30.1. POST활성화

이 작업은 연결된 스토리지 도메인을 활성화합니다. 스토리지 도메인이 활성화되면 데이터 센터와 함께 사용할 수 있습니다.

POST /ovirt-engine/api/datacenters/123/storagedomains/456/activate

활성화 작업은 동작별 매개 변수를 사용하지 않으므로 요청 본문에 빈 작업이 포함되어야 합니다.

<action/>
Expand
표 6.79. 매개변수 요약
이름유형방향요약

async

부울

in

활성화를 비동기적으로 수행해야 하는지 여부를 나타냅니다.

6.30.2. POST비활성화

이 작업은 연결된 스토리지 도메인을 비활성화합니다. 스토리지 도메인이 비활성화되면 데이터 센터와 함께 사용되지 않습니다. 예를 들어 스토리지 도메인 456 을 비활성화하려면 다음 요청을 보냅니다.

POST /ovirt-engine/api/datacenters/123/storagedomains/456/deactivate

다음과 같이 요청 본문이 있는 경우:

<action/>

force 매개변수가 true 이면 스토리지 도메인을 비활성화하기 전에 OVF 업데이트가 수행되는 경우에도 작업이 성공합니다. force 매개변수가 false 이고 OVF 업데이트가 실패한 경우 스토리지 도메인 비활성화도 실패합니다.

Expand
표 6.80. 매개변수 요약
이름유형방향요약

async

부울

in

비활성화를 비동기적으로 수행해야 하는지 여부를 나타냅니다.

force

부울

in

스토리지 도메인의 OVF 업데이트가 실패하더라도 작업이 성공하고 스토리지 도메인을 비활성화 상태로 이동해야 하는지 여부를 나타냅니다.

6.30.2.1. force

스토리지 도메인의 OVF 업데이트가 실패하더라도 작업이 성공하고 스토리지 도메인을 비활성화 상태로 이동해야 하는지 여부를 나타냅니다. 예를 들어 force 플래그를 사용하여 스토리지 도메인 456 을 비활성화하려면 다음 요청을 보냅니다.

POST /ovirt-engine/api/datacenters/123/storagedomains/456/deactivate

다음과 같이 요청 본문이 있는 경우:

<action>
  <force>true</force>
<action>

이 매개변수는 선택 사항이며 기본값은 false 입니다.

6.30.3. GET가져오기

Expand
표 6.81. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

storage_domain

StorageDomain

Out

 
6.30.3.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.30.4. DELETE제거

Expand
표 6.82. 매개변수 요약
이름유형방향요약

async

부울

in

제거가 비동기적으로 수행되어야 하는지 여부를 나타냅니다.

6.31. AttachedStorageDomainDisk

데이터 센터에 연결된 스토리지 도메인에서 사용 가능한 단일 디스크를 관리합니다.

중요

엔진의 버전 4.2부터 이 서비스는 스토리지 도메인에서 사용 가능한 디스크를 나열하고 등록되지 않은 디스크를 등록하기 위한 용도로만 사용됩니다. 디스크를 복사, 디스크 등의 이동과 같은 다른 모든 작업은 더 이상 사용되지 않으며 향후 제거될 예정입니다. 이러한 작업을 수행하려면 시스템의 모든 디스크를 관리하는 서비스 또는 특정 디스크를 관리하는 서비스를 사용합니다.

Expand
표 6.83. 메서드 요약
이름요약

복사

지정된 스토리지 도메인에 디스크를 복사합니다.

export

디스크를 내보내기 스토리지 도메인으로 내보냅니다.

get

디스크의 설명을 검색합니다.

이동

디스크를 다른 스토리지 도메인으로 이동합니다.

register

등록되지 않은 디스크를 등록합니다.

제거

디스크를 제거합니다.

sparsify

디스크를 확장합니다.

update

디스크를 업데이트합니다.

6.31.1. POST복사

지정된 스토리지 도메인에 디스크를 복사합니다.

중요

엔진의 버전 4.2부터 이 작업은 더 이상 사용되지 않으며 이전 버전과의 호환성을 위해서만 유지됩니다. 이는 향후 삭제될 예정입니다. 디스크를 복사하려면 해당 디스크를 관리하는 서비스의 복사 작업을 사용합니다.

Expand
표 6.84. 매개변수 요약
이름유형방향요약

disk

디스크

in

결과 디스크에 대한 설명입니다.

storage_domain

StorageDomain

in

새 디스크가 생성될 스토리지 도메인입니다.

6.31.2. 내보내기 POST

디스크를 내보내기 스토리지 도메인으로 내보냅니다.

중요

엔진의 버전 4.2부터 이 작업은 더 이상 사용되지 않으며 이전 버전과의 호환성을 위해서만 유지됩니다. 이는 향후 삭제될 예정입니다. 디스크를 내보내려면 해당 디스크를 관리하는 서비스의 내보내기 작업을 사용합니다.

Expand
표 6.85. 매개변수 요약
이름유형방향요약

storage_domain

StorageDomain

in

디스크를 내보내야 하는 내보내기 스토리지 도메인입니다.

6.31.3. GET가져오기

디스크의 설명을 검색합니다.

Expand
표 6.86. 매개변수 요약
이름유형방향요약

disk

디스크

Out

디스크에 대한 설명입니다.

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

6.31.3.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.31.4. POST이동

디스크를 다른 스토리지 도메인으로 이동합니다.

중요

엔진의 버전 4.2부터 이 작업은 더 이상 사용되지 않으며 이전 버전과의 호환성을 위해서만 유지됩니다. 이는 향후 삭제될 예정입니다. 디스크를 이동하려면 해당 디스크를 관리하는 서비스의 이동 작업을 사용합니다.

Expand
표 6.87. 매개변수 요약
이름유형방향요약

async

부울

in

비동기적으로 이동을 수행할지 여부를 나타냅니다.Indicates if the move should be performed asynchronously.

filter

부울

in

사용자의 권한에 따라 결과를 필터링해야 하는지 여부를 나타냅니다.

storage_domain

StorageDomain

in

디스크를 이동할 스토리지 도메인입니다.

6.31.5. POST등록

등록되지 않은 디스크를 등록합니다.

6.31.6. DELETE제거

디스크를 제거합니다.

중요

엔진의 버전 4.2부터 이 작업은 더 이상 사용되지 않으며 이전 버전과의 호환성을 위해서만 유지됩니다. 이는 향후 삭제될 예정입니다. 디스크를 제거하려면 해당 디스크를 관리하는 서비스의 제거 작업을 사용합니다.

6.31.7. sparsify POST

디스크를 확장합니다.

중요

엔진의 버전 4.2부터 이 작업은 더 이상 사용되지 않으며 이전 버전과의 호환성을 위해서만 유지됩니다. 이는 향후 삭제될 예정입니다. 디스크를 제거하려면 해당 디스크를 관리하는 서비스의 제거 작업을 사용합니다.

6.31.8. PUT업데이트

디스크를 업데이트합니다.

중요

엔진의 버전 4.2부터 이 작업은 더 이상 사용되지 않으며 이전 버전과의 호환성을 위해서만 유지됩니다. 이는 향후 삭제될 예정입니다. 디스크를 업데이트하려면 해당 디스크를 관리하는 서비스의 업데이트 작업을 사용합니다.

Expand
표 6.88. 매개변수 요약
이름유형방향요약

disk

디스크

in/Out

디스크에 적용할 업데이트입니다.

6.32. AttachedStorageDomainDisks

데이터 센터에 연결된 스토리지 도메인 내에서 사용 가능한 디스크 컬렉션을 관리합니다.

Expand
표 6.89. 메서드 요약
이름요약

add

디스크를 추가하거나 등록합니다.

list

스토리지 도메인에서 사용 가능한 디스크 목록을 검색합니다.

6.32.1. POST추가

디스크를 추가하거나 등록합니다.

중요

엔진의 버전 4.2부터 이 작업은 더 이상 사용되지 않으며 이전 버전과의 호환성을 위해서만 유지됩니다. 이는 향후 삭제될 예정입니다. 새 디스크를 추가하려면 시스템의 디스크를 관리하는 서비스의 추가 작업을 사용합니다. 등록되지 않은 디스크를 등록하려면 해당 디스크를 관리하는 서비스의 register 작업을 사용합니다.

Expand
표 6.90. 매개변수 요약
이름유형방향요약

disk

디스크

in/Out

추가하거나 등록할 디스크입니다.

등록되지 않음

부울

in

새 디스크를 추가해야 하는지 또는 기존 등록되지 않은 디스크를 등록해야 하는지 여부를 나타냅니다.

6.32.1.1. 등록되지 않음

새 디스크를 추가해야 하는지 또는 기존 등록되지 않은 디스크를 등록해야 하는지 여부를 나타냅니다. 값이 true 인 경우 등록할 디스크의 식별자를 제공해야 합니다. 예를 들어, ID 456 으로 디스크를 등록하려면 다음과 같은 요청을 보냅니다.

POST /ovirt-engine/api/storagedomains/123/disks?unregistered=true

다음과 같이 요청 본문이 있는 경우:

<disk id="456"/>

값이 false 이면 스토리지 도메인에 새 디스크가 생성됩니다. 이 경우 provisioned_size,formatname 속성이 필수입니다. 예를 들어 1GiB의 쓰기 디스크에 새 복사본 을 생성하려면 다음과 같은 요청을 보냅니다.

POST /ovirt-engine/api/storagedomains/123/disks

다음과 같이 요청 본문이 있는 경우:

<disk>
  <name>mydisk</name>
  <format>cow</format>
  <provisioned_size>1073741824</provisioned_size>
</disk>

기본값은 false입니다.

6.32.2. GET나열

스토리지 도메인에서 사용 가능한 디스크 목록을 검색합니다.

Expand
표 6.91. 매개변수 요약
이름유형방향요약

디스크

Disk[]

Out

검색된 디스크 목록.

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 최대 디스크 수를 설정합니다.

6.32.2.1. 디스크

검색된 디스크 목록.

반환된 디스크의 순서는 보장되지 않습니다.

6.32.2.2. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.32.2.3. max

반환할 최대 디스크 수를 설정합니다. 지정하지 않으면 모든 디스크가 반환됩니다.

6.33. AttachedStorageDomains

데이터 센터에 연결된 스토리지 도메인을 관리합니다.

Expand
표 6.92. 메서드 요약
이름요약

add

기존 스토리지 도메인을 데이터 센터에 연결합니다.

list

데이터 센터에 연결된 스토리지 도메인 목록을 반환합니다.

6.33.1. POST추가

기존 스토리지 도메인을 데이터 센터에 연결합니다.

Expand
표 6.93. 매개변수 요약
이름유형방향요약

storage_domain

StorageDomain

in/Out

데이터 센터에 연결할 스토리지 도메인입니다.

6.33.2. GET나열

데이터 센터에 연결된 스토리지 도메인 목록을 반환합니다.

반환된 스토리지 도메인의 순서는 보장되지 않습니다.

Expand
표 6.94. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 최대 스토리지 도메인 수를 설정합니다.

storage_domains

StorageDomain[]

Out

데이터 센터에 연결된 스토리지 도메인 목록입니다.

6.33.2.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.33.2.2. max

반환할 최대 스토리지 도메인 수를 설정합니다. 지정하지 않으면 모든 스토리지 도메인이 반환됩니다.

6.34. balance

Expand
표 6.95. 메서드 요약
이름요약

get

 

제거

 

6.34.1. GET가져오기

Expand
표 6.96. 매개변수 요약
이름유형방향요약

balance

balance

Out

 

filter

부울

in

사용자의 권한에 따라 결과를 필터링해야 하는지 여부를 나타냅니다.

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

6.34.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.34.2. DELETE제거

Expand
표 6.97. 매개변수 요약
이름유형방향요약

async

부울

in

제거가 비동기적으로 수행되어야 하는지 여부를 나타냅니다.

6.35. balances

Expand
표 6.98. 메서드 요약
이름요약

add

지정된 사용자 정의 스케줄링 정책에 balance 모듈을 추가합니다.

list

스케줄링 정책에서 사용하는 밸런스 모듈 목록을 반환합니다.

6.35.1. POST추가

지정된 사용자 정의 스케줄링 정책에 balance 모듈을 추가합니다.

Expand
표 6.99. 매개변수 요약
이름유형방향요약

balance

balance

in/Out

 

6.35.2. GET나열

스케줄링 정책에서 사용하는 밸런스 모듈 목록을 반환합니다.

반환된 밸런스 모듈의 순서는 보장되지 않습니다.

Expand
표 6.100. 매개변수 요약
이름유형방향요약

balances

balance []

Out

 

filter

부울

in

사용자의 권한에 따라 결과를 필터링해야 하는지 여부를 나타냅니다.

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 밸런스 수를 설정합니다.

6.35.2.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.35.2.2. max

반환할 밸런스 수를 설정합니다. 지정하지 않으면 모든 밸런스가 반환됩니다.

6.36. 북경기

책갈피를 관리하는 서비스입니다.

Expand
표 6.101. 메서드 요약
이름요약

get

북마크를 가져옵니다.

제거

즐겨찾기를 제거합니다.

update

즐겨찾기를 업데이트합니다.

6.36.1. GET가져오기

북마크를 가져옵니다.

즐겨찾기를 가져오는 예제:An example for getting a bookmark:

GET /ovirt-engine/api/bookmarks/123
<bookmark href="/ovirt-engine/api/bookmarks/123" id="123">
  <name>example_vm</name>
  <value>vm: name=example*</value>
</bookmark>
Expand
표 6.102. 매개변수 요약
이름유형방향요약

bookmark

북경기

Out

요청된 북경고입니다.

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

6.36.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.36.2. DELETE제거

즐겨찾기를 제거합니다.

즐겨찾기를 삭제하는 예제:An example for removing a bookmark:

DELETE /ovirt-engine/api/bookmarks/123
Expand
표 6.103. 매개변수 요약
이름유형방향요약

async

부울

in

제거가 비동기적으로 수행되어야 하는지 여부를 나타냅니다.

6.36.3. PUT업데이트

즐겨찾기를 업데이트합니다.

즐겨찾기를 업데이트하는 예제:An example for updating a bookmark:

PUT /ovirt-engine/api/bookmarks/123

요청 본문을 사용하는 경우:

<bookmark>
  <name>new_example_vm</name>
  <value>vm: name=new_example*</value>
</bookmark>
Expand
표 6.104. 매개변수 요약
이름유형방향요약

async

부울

in

업데이트를 비동기적으로 수행해야 하는지 여부를 나타냅니다.

bookmark

북경기

in/Out

업데이트된 북경고입니다.

6.37. marks

책갈피를 관리하는 서비스입니다.

Expand
표 6.105. 메서드 요약
이름요약

add

새 즐겨찾기를 추가합니다.

list

사용 가능한 모든 확장 프로그램 나열.

6.37.1. POST추가

새 즐겨찾기를 추가합니다.

즐겨찾기를 추가하는 예:

POST /ovirt-engine/api/bookmarks
<bookmark>
  <name>new_example_vm</name>
  <value>vm: name=new_example*</value>
</bookmark>
Expand
표 6.106. 매개변수 요약
이름유형방향요약

bookmark

북경기

in/Out

추가된 즐겨찾기입니다.

6.37.2. GET나열

사용 가능한 모든 확장 프로그램 나열.

확장 프로그램 나열 예:

GET /ovirt-engine/api/bookmarks
<bookmarks>
  <bookmark href="/ovirt-engine/api/bookmarks/123" id="123">
    <name>database</name>
    <value>vm: name=database*</value>
  </bookmark>
  <bookmark href="/ovirt-engine/api/bookmarks/456" id="456">
    <name>example</name>
    <value>vm: name=example*</value>
  </bookmark>
</bookmarks>

반환된 책갈피의 순서는 보장되지 않습니다.

Expand
표 6.107. 매개변수 요약
이름유형방향요약

bookmarks

Bookmark[]

Out

사용 가능한 확장 프로그램 목록입니다.

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 책갈피의 최대 수를 설정합니다.Sets the maximum number of viewing to return.

6.37.2.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.37.2.2. max

반환할 책갈피의 최대 수를 설정합니다.Sets the maximum number of viewing to return. 지정하지 않으면 모든 책갈피가 반환됩니다.

6.38. Cluster

특정 클러스터를 관리하는 서비스입니다.

Expand
표 6.108. 메서드 요약
이름요약

get

클러스터에 대한 정보를 가져옵니다.

refreshglusterhealstatus

클러스터의 모든 볼륨에 대한 Gluster 복구 정보를 새로 고칩니다.

제거

시스템에서 클러스터를 제거합니다.

resetemulatedmachine

 

syncallnetworks

클러스터의 모든 네트워크를 동기화합니다.

update

클러스터에 대한 정보를 업데이트합니다.

upgrade

작업 값에 따라 클러스터의 업그레이드 프로세스를 시작, 업데이트 또는 완료합니다.

6.38.1. GET가져오기

클러스터에 대한 정보를 가져옵니다.

클러스터 가져오기의 예:

GET /ovirt-engine/api/clusters/123
<cluster href="/ovirt-engine/api/clusters/123" id="123">
  <actions>
    <link href="/ovirt-engine/api/clusters/123/resetemulatedmachine" rel="resetemulatedmachine"/>
  </actions>
  <name>Default</name>
  <description>The default server cluster</description>
  <link href="/ovirt-engine/api/clusters/123/networks" rel="networks"/>
  <link href="/ovirt-engine/api/clusters/123/permissions" rel="permissions"/>
  <link href="/ovirt-engine/api/clusters/123/glustervolumes" rel="glustervolumes"/>
  <link href="/ovirt-engine/api/clusters/123/glusterhooks" rel="glusterhooks"/>
  <link href="/ovirt-engine/api/clusters/123/affinitygroups" rel="affinitygroups"/>
  <link href="/ovirt-engine/api/clusters/123/cpuprofiles" rel="cpuprofiles"/>
  <ballooning_enabled>false</ballooning_enabled>
  <cpu>
    <architecture>x86_64</architecture>
    <type>Intel Nehalem Family</type>
  </cpu>
  <error_handling>
    <on_error>migrate</on_error>
  </error_handling>
  <fencing_policy>
    <enabled>true</enabled>
    <skip_if_connectivity_broken>
      <enabled>false</enabled>
      <threshold>50</threshold>
    </skip_if_connectivity_broken>
    <skip_if_sd_active>
      <enabled>false</enabled>
    </skip_if_sd_active>
  </fencing_policy>
  <gluster_service>false</gluster_service>
  <ha_reservation>false</ha_reservation>
  <ksm>
    <enabled>true</enabled>
    <merge_across_nodes>true</merge_across_nodes>
  </ksm>
  <memory_policy>
    <over_commit>
      <percent>100</percent>
    </over_commit>
    <transparent_hugepages>
      <enabled>true</enabled>
    </transparent_hugepages>
  </memory_policy>
  <migration>
    <auto_converge>inherit</auto_converge>
    <bandwidth>
      <assignment_method>auto</assignment_method>
    </bandwidth>
    <compressed>inherit</compressed>
  </migration>
  <required_rng_sources>
    <required_rng_source>random</required_rng_source>
  </required_rng_sources>
  <scheduling_policy href="/ovirt-engine/api/schedulingpolicies/456" id="456"/>
  <threads_as_cores>false</threads_as_cores>
  <trusted_service>false</trusted_service>
  <tunnel_migration>false</tunnel_migration>
  <version>
    <major>4</major>
    <minor>0</minor>
  </version>
  <virt_service>true</virt_service>
  <data_center href="/ovirt-engine/api/datacenters/111" id="111"/>
</cluster>
Expand
표 6.109. 매개변수 요약
이름유형방향요약

cluster

Cluster

Out

 

filter

부울

in

사용자의 권한에 따라 결과를 필터링해야 하는지 여부를 나타냅니다.

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

6.38.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.38.2. refreshglusterhealstatus POST

클러스터의 모든 볼륨에 대한 Gluster 복구 정보를 새로 고칩니다.

예를 들어 Cluster 123 에서 다음과 같은 요청을 보냅니다.

POST /ovirt-engine/api/clusters/123/refreshglusterhealstatus

6.38.3. DELETE제거

시스템에서 클러스터를 제거합니다.

DELETE /ovirt-engine/api/clusters/00000000-0000-0000-0000-000000000000
Expand
표 6.110. 매개변수 요약
이름유형방향요약

async

부울

in

제거가 비동기적으로 수행되어야 하는지 여부를 나타냅니다.

6.38.4. resetemulatedmachine POST

Expand
표 6.111. 매개변수 요약
이름유형방향요약

async

부울

in

재설정이 비동기적으로 수행되어야 하는지 여부를 나타냅니다.

6.38.5. syncallnetworks POST

클러스터의 모든 네트워크를 동기화합니다.

POST /ovirt-engine/api/clusters/123/syncallnetworks

다음과 같이 요청 본문이 있는 경우:

<action/>
Expand
표 6.112. 매개변수 요약
이름유형방향요약

async

부울

in

비동기적으로 작업을 수행해야 하는지 여부를 나타냅니다.Indicates whether the action should be performed asynchronously.

6.38.6. PUT업데이트

클러스터에 대한 정보를 업데이트합니다.

지정된 필드만 업데이트되고 다른 필드는 변경되지 않습니다.

예를 들어 클러스터의 CPU를 업데이트하려면 다음을 수행합니다.

PUT /ovirt-engine/api/clusters/123

다음과 같이 요청 본문이 있는 경우:

<cluster>
  <cpu>
    <type>Intel Haswell-noTSX Family</type>
  </cpu>
</cluster>
Expand
표 6.113. 매개변수 요약
이름유형방향요약

async

부울

in

업데이트를 비동기적으로 수행해야 하는지 여부를 나타냅니다.

cluster

Cluster

in/Out

 

6.38.7. 업그레이드 POST

작업 값에 따라 클러스터의 업그레이드 프로세스를 시작, 업데이트 또는 완료합니다. 이 작업은 업그레이드용 클러스터를 표시하거나, 진행 상황을 업데이트하거나, 시작,stop 또는 update_progress 값을 사용하는 작업 값을 기반으로 클러스터에서 실행 중인 업그레이드 플래그를 지웁니다.

POST /ovirt-engine/api/clusters/123/upgrade

이와 같은 요청 본문을 사용하면 클러스터를 업그레이드하도록 표시합니다.

<action>
    <upgrade_action>
        start
    </upgrade_action>
</action>

업그레이드를 시작한 후 이와 같은 요청 본문을 사용하여 진행 상황을 15 %로 업데이트합니다.

<action>
    <upgrade_action>
        update_progress
    </upgrade_action>
    <upgrade_percent_complete>
        15
    </upgrade_percent_complete>
</action>
Expand
표 6.114. 매개변수 요약
이름유형방향요약

async

부울

in

비동기적으로 작업을 수행해야 하는지 여부를 나타냅니다.Indicates whether the action should be performed asynchronously.

correlation_id

문자열

in

업그레이드 상관 관계 식별자를 명시적으로 설정합니다.

upgrade_action

ClusterUpgradeAction

in

수행할 작업입니다.

upgrade_percent_complete

정수

in

전체 프로세스의 백분율로 업그레이드 진행 상황을 업데이트합니다.

6.38.7.1. correlation_id

업그레이드 상관 관계 식별자를 명시적으로 설정합니다. 을 사용하여 클러스터 업그레이드에 대한 세부적인 이벤트를 업그레이드 자체에 연결합니다. 별도로 지정하지 않으면 Correlation-Id http 헤더의 상관 ID가 사용됩니다.

6.39. ClusterEnabledFeature

클러스터에 활성화된 기능을 나타냅니다.

Expand
표 6.115. 메서드 요약
이름요약

get

활성화된 클러스터 기능에 대한 정보를 제공합니다.

제거

클러스터 기능을 비활성화합니다.

6.39.1. GET가져오기

활성화된 클러스터 기능에 대한 정보를 제공합니다.

예를 들어 클러스터 123 에 대해 활성화된 기능 456 의 세부 정보를 찾으려면 다음과 같은 요청을 보냅니다.

GET /ovirt-engine/api/clusters/123/enabledfeatures/456

그러면 이름이 포함된 ClusterFeature 오브젝트가 반환됩니다.

<cluster_feature id="456">
  <name>libgfapi_supported</name>
</cluster_feature>
Expand
표 6.116. 매개변수 요약
이름유형방향요약

기능

ClusterFeature

Out

활성화된 클러스터 기능을 검색합니다.

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

6.39.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.39.2. DELETE제거

클러스터 기능을 비활성화합니다.

예를 들어 클러스터 123 의 기능 456 을 비활성화하려면 다음과 같은 요청을 보냅니다.

DELETE /ovirt-engine/api/clusters/123/enabledfeatures/456

6.40. ClusterEnabledFeatures

이 클러스터에 활성화된 추가 기능에 대한 정보를 제공합니다. 활성화된 기능은 클러스터 수준에서 사용 가능한 기능입니다.

Expand
표 6.117. 메서드 요약
이름요약

add

클러스터에 추가 기능을 활성화합니다.

list

클러스터에 활성화된 추가 기능을 나열합니다.

6.40.1. POST추가

클러스터에 추가 기능을 활성화합니다.

예를 들어 클러스터 123 에서 기능 456 을 활성화하려면 다음과 같은 요청을 보냅니다.

POST /ovirt-engine/api/clusters/123/enabledfeatures

요청 본문은 다음과 같아야 합니다.

<cluster_feature id="456"/>
Expand
표 6.118. 매개변수 요약
이름유형방향요약

기능

ClusterFeature

in/Out

 

6.40.2. GET나열

클러스터에 활성화된 추가 기능을 나열합니다.

예를 들어 클러스터 123 에 대해 활성화된 기능을 얻으려면 다음과 같은 요청을 보냅니다.

GET /ovirt-engine/api/clusters/123/enabledfeatures

그러면 기능 목록이 반환됩니다.

<enabled_features>
  <cluster_feature id="123">
     <name>test_feature</name>
  </cluster_feature>
  ...
</enabled_features>
Expand
표 6.119. 매개변수 요약
이름유형방향요약

기능

ClusterFeature[]

Out

검색된 기능.

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

6.40.2.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.41. ClusterExternalProviders

이 서비스에는 외부 공급자가 나열됩니다.

Expand
표 6.120. 메서드 요약
이름요약

list

외부 공급자 목록을 반환합니다.

6.41.1. GET나열

외부 공급자 목록을 반환합니다.

반환된 공급자 목록의 순서는 보장되지 않습니다.

Expand
표 6.121. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

providers

ExternalProvider[]

Out

 
6.41.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.42. ClusterFeature

클러스터 수준에 활성화된 기능을 나타냅니다.

Expand
표 6.122. 메서드 요약
이름요약

get

클러스터 수준에서 지원하는 클러스터 기능에 대한 정보를 제공합니다.

6.42.1. GET가져오기

클러스터 수준에서 지원하는 클러스터 기능에 대한 정보를 제공합니다.

예를 들어 클러스터 수준 4.1의 클러스터 기능 456 에 대한 세부 정보를 찾으려면 다음과 같은 요청을 보냅니다.

GET /ovirt-engine/api/clusterlevels/4.1/clusterfeatures/456

그러면 이름이 포함된 ClusterFeature 오브젝트가 반환됩니다.

<cluster_feature id="456">
  <name>libgfapi_supported</name>
</cluster_feature>
Expand
표 6.123. 매개변수 요약
이름유형방향요약

기능

ClusterFeature

Out

검색된 클러스터 기능.

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

6.42.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.43. ClusterFeatures

클러스터 수준에서 지원하는 클러스터 기능에 대한 정보를 제공합니다.

Expand
표 6.124. 메서드 요약
이름요약

list

클러스터 수준에서 지원하는 클러스터 기능을 나열합니다.

6.43.1. GET나열

클러스터 수준에서 지원하는 클러스터 기능을 나열합니다.

GET /ovirt-engine/api/clusterlevels/4.1/clusterfeatures

그러면 클러스터 수준에서 지원하는 클러스터 기능 목록이 반환됩니다.

<cluster_features>
  <cluster_feature id="123">
     <name>test_feature</name>
  </cluster_feature>
  ...
</cluster_features>
Expand
표 6.125. 매개변수 요약
이름유형방향요약

기능

ClusterFeature[]

Out

검색된 기능.

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

6.43.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.44. ClusterLevel

특정 클러스터 수준에 대한 정보를 제공합니다. 자세한 내용은 ClusterLevels 서비스를 참조하십시오.

Expand
표 6.126. 메서드 요약
이름요약

get

이 서비스에서 관리하는 특정 클러스터 수준의 기능에 대한 정보를 제공합니다.

6.44.1. GET가져오기

이 서비스에서 관리하는 특정 클러스터 수준의 기능에 대한 정보를 제공합니다.

예를 들어, 3.6 수준에서 지원하는 CPU 유형을 찾으려면 다음과 같은 요청을 보낼 수 있습니다.

GET /ovirt-engine/api/clusterlevels/3.6

이렇게 하면 지원되는 CPU 유형과 클러스터 수준을 설명하는 기타 정보가 포함된 ClusterLevel 오브젝트가 반환됩니다.

<cluster_level id="3.6">
  <cpu_types>
    <cpu_type>
      <name>Intel Nehalem Family</name>
      <level>3</level>
      <architecture>x86_64</architecture>
    </cpu_type>
    ...
  </cpu_types>
  <permits>
    <permit id="1">
      <name>create_vm</name>
      <administrative>false</administrative>
    </permit>
    ...
  </permits>
</cluster_level>
Expand
표 6.127. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

level

ClusterLevel

Out

재귀적 클러스터 수준입니다.

6.44.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.45. ClusterLevels

엔진에서 지원하는 다양한 클러스터 수준의 기능에 대한 정보를 제공합니다. 엔진의 버전 4.0은 레벨 4.0 및 3.6을 지원합니다. 이러한 각 수준은 예를 들어 서로 다른 CPU 유형 집합을 지원합니다. 이 서비스는 이러한 정보를 제공합니다.

Expand
표 6.128. 메서드 요약
이름요약

list

시스템에서 지원하는 클러스터 수준을 나열합니다.

6.45.1. GET나열

시스템에서 지원하는 클러스터 수준을 나열합니다.

GET /ovirt-engine/api/clusterlevels

그러면 사용 가능한 클러스터 수준 목록이 반환됩니다.

<cluster_levels>
  <cluster_level id="4.0">
     ...
  </cluster_level>
  ...
</cluster_levels>

반환된 클러스터 수준의 순서는 보장되지 않습니다.

Expand
표 6.129. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

수준

ClusterLevel[]

Out

검색된 클러스터 수준.

6.45.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.46. ClusterNetwork

특정 클러스터 네트워크를 관리하는 서비스입니다.

Expand
표 6.130. 메서드 요약
이름요약

get

클러스터 네트워크 세부 정보를 검색합니다.

제거

클러스터에서 네트워크 할당을 해제합니다.

update

클러스터의 네트워크를 업데이트합니다.

6.46.1. GET가져오기

클러스터 네트워크 세부 정보를 검색합니다.

Expand
표 6.131. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

network

네트워크

Out

클러스터 네트워크

6.46.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.46.2. DELETE제거

클러스터에서 네트워크 할당을 해제합니다.

6.46.3. PUT업데이트

클러스터의 네트워크를 업데이트합니다.

Expand
표 6.132. 매개변수 요약
이름유형방향요약

network

네트워크

in/Out

클러스터 네트워크

6.47. ClusterNetworks

클러스터 네트워크를 관리하는 서비스입니다.

Expand
표 6.133. 메서드 요약
이름요약

add

네트워크를 클러스터에 할당합니다.

list

클러스터에 할당된 네트워크를 나열합니다.

6.47.1. POST추가

네트워크를 클러스터에 할당합니다.

아래 예제와 같은 요청을 게시하여 네트워크를 클러스터에 할당합니다.

POST /ovirt-engine/api/clusters/123/networks

본문에 다음 예제를 사용합니다.

<network id="123" />
Expand
표 6.134. 매개변수 요약
이름유형방향요약

network

네트워크

in/Out

클러스터에 할당할 네트워크 오브젝트입니다.

6.47.2. GET나열

클러스터에 할당된 네트워크를 나열합니다.

반환된 클러스터의 순서는 보장되지 않습니다.

Expand
표 6.135. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 최대 네트워크 수를 설정합니다.

networks

Network[]

Out

클러스터에 할당된 네트워크 목록입니다.

6.47.2.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.47.2.2. max

반환할 최대 네트워크 수를 설정합니다. 지정하지 않으면 모든 네트워크가 반환됩니다.

6.48. 클러스터

클러스터를 관리하는 서비스입니다.

Expand
표 6.136. 메서드 요약
이름요약

add

새 클러스터를 생성합니다.

list

시스템의 클러스터 목록을 반환합니다.

6.48.1. POST추가

새 클러스터를 생성합니다.

이름,cpu.type, data_center 속성이 필요합니다. id 또는 name 속성을 사용하여 데이터 센터를 식별합니다.

POST /ovirt-engine/api/clusters

다음과 같이 요청 본문이 있는 경우:

<cluster>
  <name>mycluster</name>
  <cpu>
    <type>Intel Nehalem Family</type>
  </cpu>
  <data_center id="123"/>
</cluster>

클러스터에 추가된 모든 호스트에 배포할 외부 네트워크 공급자로 클러스터를 생성하려면 다음과 같이 요청을 보냅니다.

POST /ovirt-engine/api/clusters

원하는 공급자에 대한 참조가 포함된 요청 본문:

<cluster>
  <name>mycluster</name>
  <cpu>
    <type>Intel Nehalem Family</type>
  </cpu>
  <data_center id="123"/>
  <external_network_providers>
    <external_provider name="ovirt-provider-ovn"/>
  </external_network_providers>
</cluster>
Expand
표 6.137. 매개변수 요약
이름유형방향요약

cluster

Cluster

in/Out

 

6.48.2. GET나열

시스템의 클러스터 목록을 반환합니다.

반환된 클러스터의 순서는 sortby 절이 검색 매개변수에 포함된 경우에만 보장됩니다.

Expand
표 6.138. 매개변수 요약
이름유형방향요약

case_sensitive

부울

in

대소문자를 고려하여 검색을 수행해야 하는지 여부를 나타냅니다.

clusters

Cluster[]

Out

 

filter

부울

in

사용자의 권한에 따라 결과를 필터링해야 하는지 여부를 나타냅니다.

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 최대 클러스터 수를 설정합니다.

search

문자열

in

반환된 클러스터를 제한하는 데 사용되는 쿼리 문자열입니다.

6.48.2.1. case_sensitive

대소문자를 고려하여 검색을 수행해야 하는지 여부를 나타냅니다. 기본값은 true 입니다. 즉, 해당 케이스가 고려됩니다. 케이스를 무시하려면 false 로 설정합니다.

6.48.2.2. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.48.2.3. max

반환할 최대 클러스터 수를 설정합니다. 지정하지 않으면 모든 클러스터가 반환됩니다.

6.49. 복사 가능

Expand
표 6.139. 메서드 요약
이름요약

복사

 

6.49.1. POST복사

Expand
표 6.140. 매개변수 요약
이름유형방향요약

async

부울

in

복사본을 비동기적으로 수행해야 하는지 여부를 나타냅니다.Indicates if the copy should be performed asynchronously.

6.50. CpuProfile

Expand
표 6.141. 메서드 요약
이름요약

get

 

제거

 

update

시스템에서 지정된 cpu 프로필을 업데이트합니다.

6.50.1. GET가져오기

Expand
표 6.142. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

profile

CpuProfile

Out

 
6.50.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.50.2. DELETE제거

Expand
표 6.143. 매개변수 요약
이름유형방향요약

async

부울

in

제거가 비동기적으로 수행되어야 하는지 여부를 나타냅니다.

6.50.3. PUT업데이트

시스템에서 지정된 cpu 프로필을 업데이트합니다.

Expand
표 6.144. 매개변수 요약
이름유형방향요약

async

부울

in

업데이트를 비동기적으로 수행해야 하는지 여부를 나타냅니다.

profile

CpuProfile

in/Out

 

6.51. CpuProfiles

Expand
표 6.145. 메서드 요약
이름요약

add

시스템에 새 cpu 프로필을 추가합니다.

list

시스템의 CPU 프로필 목록을 반환합니다.

6.51.1. POST추가

시스템에 새 cpu 프로필을 추가합니다.

Expand
표 6.146. 매개변수 요약
이름유형방향요약

profile

CpuProfile

in/Out

 

6.51.2. GET나열

시스템의 CPU 프로필 목록을 반환합니다.

반환된 CPU 프로필 목록의 순서는 random합니다.

Expand
표 6.147. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 최대 프로필 수를 설정합니다.

profile

CpuProfile[]

Out

 
6.51.2.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.51.2.2. max

반환할 최대 프로필 수를 설정합니다. 지정하지 않으면 모든 프로필이 반환됩니다.

6.52. DataCenter

데이터 센터를 관리하는 서비스입니다.

Expand
표 6.148. 메서드 요약
이름요약

cleanfinishedtasks

현재 storage pool manager(SPM)가 다른 호스트로 전환하지 못하는 경우, SPM에서 작업이 명확하지 않은 경우 다른 호스트로 전환하지 않습니다.

get

데이터 센터 가져오기.

제거

데이터 센터를 제거합니다.

setmaster

데이터 센터의 스토리지 도메인을 마스터로 수동으로 설정하는 데 사용됩니다.

update

데이터 센터를 업데이트합니다.

6.52.1. cleanfinishedtasks POST

현재 storage pool manager(SPM)가 다른 호스트로 전환하지 못하는 경우, SPM에서 작업이 명확하지 않은 경우 다른 호스트로 전환하지 않습니다. 완료된 모든 작업을 삭제하면 Restic 전환이 활성화됩니다.

예를 들어 ID가 123 인 데이터 센터에서 완료된 모든 작업을 정리하려면 다음과 같은 요청을 보냅니다.

POST /ovirt-engine/api/datacenters/123/cleanfinishedtasks

다음과 같이 요청 본문이 있는 경우:

<action/>
Expand
표 6.149. 매개변수 요약
이름유형방향요약

async

부울

in

비동기적으로 작업을 수행해야 하는지 여부를 나타냅니다.Indicates whether the action should be performed asynchronously.

6.52.2. GET가져오기

데이터 센터 가져오기.

데이터 센터를 가져오는 예:

GET /ovirt-engine/api/datacenters/123
<data_center href="/ovirt-engine/api/datacenters/123" id="123">
  <name>Default</name>
  <description>The default Data Center</description>
  <link href="/ovirt-engine/api/datacenters/123/clusters" rel="clusters"/>
  <link href="/ovirt-engine/api/datacenters/123/storagedomains" rel="storagedomains"/>
  <link href="/ovirt-engine/api/datacenters/123/permissions" rel="permissions"/>
  <link href="/ovirt-engine/api/datacenters/123/networks" rel="networks"/>
  <link href="/ovirt-engine/api/datacenters/123/quotas" rel="quotas"/>
  <link href="/ovirt-engine/api/datacenters/123/qoss" rel="qoss"/>
  <link href="/ovirt-engine/api/datacenters/123/iscsibonds" rel="iscsibonds"/>
  <local>false</local>
  <quota_mode>disabled</quota_mode>
  <status>up</status>
  <storage_format>v3</storage_format>
  <supported_versions>
    <version>
      <major>4</major>
      <minor>0</minor>
   </version>
  </supported_versions>
  <version>
    <major>4</major>
    <minor>0</minor>
  </version>
  <mac_pool href="/ovirt-engine/api/macpools/456" id="456"/>
</data_center>
Expand
표 6.150. 매개변수 요약
이름유형방향요약

data_center

DataCenter

Out

 

filter

부울

in

사용자의 권한에 따라 결과를 필터링해야 하는지 여부를 나타냅니다.

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

6.52.2.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.52.3. DELETE제거

데이터 센터를 제거합니다.

DELETE /ovirt-engine/api/datacenters/123

특수 매개 변수가 없으면 데이터 센터에 연결된 스토리지 도메인이 분리된 다음 스토리지에서 제거됩니다. 이 작업을 수행할 때 문제가 발생하는 경우(예: 스토리지에서 스토리지 도메인을 제거하는 데 사용 가능한 호스트가 없는 경우 전체 작업이 실패합니다.

force 매개변수가 true 이면 예를 들어 하나의 스토리지 도메인을 제거하는 동안 오류가 발생하는 경우에도 작업이 항상 성공합니다. 실패는 무시되고 데이터 센터가 데이터베이스에서 제거됩니다.

Expand
표 6.151. 매개변수 요약
이름유형방향요약

async

부울

in

제거가 비동기적으로 수행되어야 하는지 여부를 나타냅니다.

force

부울

in

작업이 성공해야 하는지, 작업 중에 문제가 발생하더라도 데이터베이스에서 스토리지 도메인이 제거되었는지 여부를 나타냅니다.

6.52.3.1. force

작업이 성공해야 하는지, 작업 중에 문제가 발생하더라도 데이터베이스에서 스토리지 도메인이 제거되었는지 여부를 나타냅니다.

이 매개변수는 선택 사항이며 기본값은 false 입니다.

6.52.4. setmaster POST

데이터 센터의 스토리지 도메인을 마스터로 수동으로 설정하는 데 사용됩니다. 예를 들어 ID가 '123'인 데이터 센터의 마스터로 ID가 '456'인 스토리지 도메인을 설정하려면 다음과 같은 요청을 보냅니다.

POST /ovirt-engine/api/datacenters/123/setmaster

다음과 같이 요청 본문이 있는 경우:

<action>
  <storage_domain id="456"/>
</action>

새 마스터 스토리지 도메인도 해당 이름으로 지정할 수 있습니다.

Expand
표 6.152. 매개변수 요약
이름유형방향요약

async

부울

in

비동기적으로 작업을 수행해야 하는지 여부를 나타냅니다.Indicates whether the action should be performed asynchronously.

storage_domain

StorageDomain

in

데이터 센터의 새 마스터 스토리지 도메인입니다.

6.52.5. PUT업데이트

데이터 센터를 업데이트합니다.

이름,설명,storage_type,버전,storage_formatmac_pool 요소는 데이터 생성 후입니다. 예를 들어 데이터 센터( 123 )의 이름과 설명을 변경하려면 다음과 같은 요청을 보냅니다.

PUT /ovirt-engine/api/datacenters/123

다음과 같이 요청 본문이 있는 경우:

<data_center>
  <name>myupdatedname</name>
  <description>An updated description for the data center</description>
</data_center>
Expand
표 6.153. 매개변수 요약
이름유형방향요약

async

부울

in

업데이트를 비동기적으로 수행해야 하는지 여부를 나타냅니다.

data_center

DataCenter

in/Out

업데이트 중인 데이터 센터입니다.

6.53. DataCenterNetwork

특정 데이터 센터 네트워크를 관리하는 서비스입니다.

Expand
표 6.154. 메서드 요약
이름요약

get

데이터 센터 네트워크 세부 정보를 검색합니다.

제거

네트워크를 제거합니다.

update

데이터 센터에서 네트워크를 업데이트합니다.

6.53.1. GET가져오기

데이터 센터 네트워크 세부 정보를 검색합니다.

Expand
표 6.155. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

network

네트워크

Out

데이터 센터 네트워크입니다.

6.53.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.53.2. DELETE제거

네트워크를 제거합니다.

6.53.3. PUT업데이트

데이터 센터에서 네트워크를 업데이트합니다.

Expand
표 6.156. 매개변수 요약
이름유형방향요약

network

네트워크

in/Out

데이터 센터 네트워크입니다.

6.54. DataCenterNetworks

데이터 센터 네트워크를 관리하는 서비스입니다.

Expand
표 6.157. 메서드 요약
이름요약

add

데이터 센터에 새 네트워크를 생성합니다.

list

데이터 센터의 네트워크를 나열합니다.

6.54.1. POST추가

데이터 센터에 새 네트워크를 생성합니다.

아래 예제와 같은 요청을 게시하여 ID가 123 인 데이터 센터에 새 네트워크를 생성합니다.

POST /ovirt-engine/api/datacenters/123/networks

본문에 다음 예제를 사용합니다.

<network>
  <name>mynetwork</name>
</network>
Expand
표 6.158. 매개변수 요약
이름유형방향요약

network

네트워크

in/Out

데이터 센터에서 생성할 네트워크 오브젝트입니다.

6.54.2. GET나열

데이터 센터의 네트워크를 나열합니다.

반환된 네트워크 목록의 순서는 보장되지 않습니다.

Expand
표 6.159. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 최대 네트워크 수를 설정합니다.

networks

Network[]

Out

데이터 센터에 있는 네트워크 목록입니다.

6.54.2.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.54.2.2. max

반환할 최대 네트워크 수를 설정합니다. 지정하지 않으면 모든 네트워크가 반환됩니다.

6.55. DataCenters

데이터 센터를 관리하는 서비스입니다.

Expand
표 6.160. 메서드 요약
이름요약

add

새 데이터 센터를 생성합니다.

list

데이터 센터를 나열합니다.

6.55.1. POST추가

새 데이터 센터를 생성합니다.

새 데이터 센터를 생성하려면 이름과 로컬 요소가 필요합니다. 예를 들어 공유 스토리지(NFS, iSCSI 또는 파이버 채널)를 사용하는 mydc 라는 데이터 센터를 생성하려면 다음과 같은 요청을 보냅니다.

POST /ovirt-engine/api/datacenters

다음과 같이 요청 본문이 있는 경우:

<data_center>
  <name>mydc</name>
  <local>false</local>
</data_center>
Expand
표 6.161. 매개변수 요약
이름유형방향요약

data_center

DataCenter

in/Out

추가되는 데이터 센터입니다.

6.55.2. GET나열

데이터 센터를 나열합니다.

다음 요청에서는 데이터 센터의 표현을 검색합니다.

GET /ovirt-engine/api/datacenters

위의 요청은 curl 로 수행됩니다.

curl \
--request GET \
--cacert /etc/pki/ovirt-engine/ca.pem \
--header "Version: 4" \
--header "Accept: application/xml" \
--user "admin@internal:mypassword" \
https://myengine.example.com/ovirt-engine/api/datacenters

이에 대한 예제 응답은 다음과 같습니다.

<data_center href="/ovirt-engine/api/datacenters/123" id="123">
  <name>Default</name>
  <description>The default Data Center</description>
  <link href="/ovirt-engine/api/datacenters/123/networks" rel="networks"/>
  <link href="/ovirt-engine/api/datacenters/123/storagedomains" rel="storagedomains"/>
  <link href="/ovirt-engine/api/datacenters/123/permissions" rel="permissions"/>
  <link href="/ovirt-engine/api/datacenters/123/clusters" rel="clusters"/>
  <link href="/ovirt-engine/api/datacenters/123/qoss" rel="qoss"/>
  <link href="/ovirt-engine/api/datacenters/123/iscsibonds" rel="iscsibonds"/>
  <link href="/ovirt-engine/api/datacenters/123/quotas" rel="quotas"/>
  <local>false</local>
  <quota_mode>disabled</quota_mode>
  <status>up</status>
  <supported_versions>
    <version>
      <major>4</major>
      <minor>0</minor>
    </version>
  </supported_versions>
  <version>
    <major>4</major>
    <minor>0</minor>
  </version>
</data_center>

Default 데이터 센터의 id 코드를 기록해 둡니다. 이 코드는 가상 환경의 다른 리소스와 관련하여 이 데이터 센터를 식별합니다.

데이터 센터에는 스토리지 도메인 컬렉션에 대한 링크도 포함되어 있습니다. 데이터 센터는 이 컬렉션을 사용하여 스토리지 도메인 기본 컬렉션의 스토리지 도메인을 연결합니다.

반환된 데이터 센터 목록의 순서는 sortby 절이 검색 매개 변수에 포함된 경우에만 보장됩니다.

Expand
표 6.162. 매개변수 요약
이름유형방향요약

case_sensitive

부울

in

검색 매개 변수를 사용하여 수행된 검색이 대소문자를 고려하여 수행해야 하는지 여부를 나타냅니다.

data_centers

DataCenter[]

Out

 

filter

부울

in

사용자의 권한에 따라 결과를 필터링해야 하는지 여부를 나타냅니다.

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 최대 데이터 센터 수를 설정합니다.

search

문자열

in

반환된 데이터 센터를 제한하는 데 사용되는 쿼리 문자열입니다.

6.55.2.1. case_sensitive

검색 매개 변수를 사용하여 수행된 검색이 대소문자를 고려하여 수행해야 하는지 여부를 나타냅니다. 기본값은 true 입니다. 즉, 해당 케이스가 고려됩니다. 대소문자를 무시하고자 하는 경우 false 로 설정합니다.

6.55.2.2. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.55.2.3. max

반환할 최대 데이터 센터 수를 설정합니다. 지정하지 않으면 모든 데이터 센터가 반환됩니다.

6.56. 디스크

단일 디스크를 관리합니다.

Expand
표 6.163. 메서드 요약
이름요약

convert

디스크 형식 및/또는 사전 할당 모드를 변환합니다.

복사

이 작업은 지정된 스토리지 도메인에 디스크를 복사합니다.

export

디스크를 내보내기 스토리지 도메인으로 내보냅니다.

get

디스크의 설명을 검색합니다.

이동

디스크를 다른 스토리지 도메인으로 이동합니다.

감소

디스크 이미지의 크기를 줄입니다.

refreshlun

스토리지의 최신 정보를 사용하여 직접 LUN 디스크를 새로 고칩니다.

제거

디스크를 제거합니다.

sparsify

디스크를 확장합니다.

update

지정된 디스크의 매개변수를 업데이트합니다.

6.56.1. convert POST

디스크 형식 및/또는 사전 할당 모드를 변환합니다.

예를 들어 디스크 형식을 사전allocated-cow에서 sparse-raw 이미지로 변환하려면 다음과 같은 요청을 보냅니다.

POST /ovirt-engine/api/disks/123/convert

다음과 같은 요청 본문으로:

 <action>
   <disk>
     <sparse>true</sparse>
     <format>raw</format>
   </disk>
 </action>

참고: 디스크를 확장하려면 디스크가 블록 스토리지 도메인에 있는 경우 두 개의 변환이 필요할 수 있습니다. 예를 들어 디스크가 RAW인 경우 QCOW로 변환하면 디스크 크기가 커집니다. 크기를 줄이기 위해 디스크를 QCOW로 다시 변환하고 동일한 할당 정책을 유지할 수 있습니다.

Expand
표 6.164. 매개변수 요약
이름유형방향요약

disk

디스크

in

디스크에 대한 설명입니다.

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

6.56.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.56.2. POST복사

이 작업은 지정된 스토리지 도메인에 디스크를 복사합니다.

예를 들어 다음 요청을 사용하여 디스크를 복사할 수 있습니다.

POST /ovirt-engine/api/disks/123/copy

다음과 같이 요청 본문이 있는 경우:

<action>
  <storage_domain id="456"/>
  <disk>
    <name>mydisk</name>
  </disk>
</action>

디스크에서 현재 사용하는 디스크 프로필 또는 할당량이 새 스토리지 도메인에 대해 정의되지 않은 경우 명시적으로 지정할 수 있습니다. 지정하지 않으면 사용 가능한 첫 번째 디스크 프로필과 기본 할당량이 사용됩니다.

예를 들어, 디스크 프로파일 987 및 할당량 753 을 지정하려면 다음과 같이 요청 본문을 보냅니다.

<action>
  <storage_domain id="456"/>
  <disk_profile id="987"/>
  <quota id="753"/>
</action>
Expand
표 6.165. 매개변수 요약
이름유형방향요약

async

부울

in

복사본을 비동기적으로 수행해야 하는지 여부를 나타냅니다.Indicates if the copy should be performed asynchronously.

disk

디스크

in

 

disk_profile

DiskProfile

in

새 스토리지 도메인의 디스크의 디스크 프로필입니다.

filter

부울

in

사용자의 권한에 따라 결과를 필터링해야 하는지 여부를 나타냅니다.

quota

할당량

in

새 스토리지 도메인의 디스크 할당량입니다.

storage_domain

StorageDomain

in

새 디스크가 생성된 스토리지 도메인입니다.

6.56.2.1. disk_profile

새 스토리지 도메인의 디스크의 디스크 프로필입니다.

디스크 프로필은 스토리지 도메인에 대해 정의되므로 이전 디스크 프로필이 새 스토리지 도메인에 존재하지 않습니다. 이 매개 변수를 사용하지 않으면 사용자에게 권한이 있는 새 스토리지 도메인의 첫 번째 디스크 프로필이 디스크에 할당됩니다.

6.56.2.2. 할당량

새 스토리지 도메인의 디스크 할당량입니다.

현재 할당량은 새 스토리지 도메인에 대해 정의되지 않을 수 있으므로 이 선택적 매개 변수를 사용하여 디스크에 대한 새 할당량을 지정할 수 있습니다. 이 매개 변수를 사용하지 않고 새 스토리지 도메인에 대해 이전 할당량이 정의되지 않은 경우 default(제한 없음) 할당량이 디스크에 할당됩니다.

6.56.2.3. storage_domain

새 디스크가 생성된 스토리지 도메인입니다. id 또는 name 속성을 사용하여 지정할 수 있습니다. 예를 들어, 디스크를 mydata 라는 스토리지 도메인에 복사하려면 다음과 같은 요청을 보냅니다.

POST /ovirt-engine/api/storagedomains/123/disks/789

다음과 같이 요청 본문이 있는 경우:

<action>
  <storage_domain>
    <name>mydata</name>
  </storage_domain>
</action>

6.56.3. 내보내기 POST

디스크를 내보내기 스토리지 도메인으로 내보냅니다.

Expand
표 6.166. 매개변수 요약
이름유형방향요약

async

부울

in

비동기적으로 내보내기를 수행해야 하는지 여부를 나타냅니다.Indicates whether the export should be performed asynchronously.

filter

부울

in

사용자의 권한에 따라 결과를 필터링해야 하는지 여부를 나타냅니다.

storage_domain

StorageDomain

in

디스크를 내보낼 내보내기 스토리지 도메인입니다.

6.56.4. GET가져오기

디스크의 설명을 검색합니다.

Expand
표 6.167. 매개변수 요약
이름유형방향요약

all_content

부울

in

디스크의 모든 속성이 응답에 포함되어야 하는지 여부를 나타냅니다.

disk

디스크

Out

디스크에 대한 설명입니다.

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

6.56.4.1. all_content

디스크의 모든 속성이 응답에 포함되어야 하는지 여부를 나타냅니다.

기본적으로 다음 디스크 속성은 제외됩니다.

  • vms

예를 들어 '123' 디스크의 전체 표현을 검색하려면 다음을 수행합니다.

GET /ovirt-engine/api/disks/123?all_content=true
6.56.4.2. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.56.5. POST이동

디스크를 다른 스토리지 도메인으로 이동합니다.

예를 들어 식별자가 123 인 디스크를 식별자( 456 )가 있는 스토리지 도메인으로 이동하려면 다음 요청을 보냅니다.

POST /ovirt-engine/api/disks/123/move

다음과 같은 요청 본문으로:

<action>
  <storage_domain id="456"/>
</action>

디스크에서 현재 사용하는 디스크 프로필 또는 할당량이 새 스토리지 도메인에 대해 정의되지 않은 경우 명시적으로 지정할 수 있습니다. 그런 다음 사용 가능한 첫 번째 디스크 프로필이 아닌 경우 기본 할당량이 사용됩니다.

예를 들어 디스크 프로파일 987 및 할당량 753 을 명시적으로 사용하려면 다음과 같이 요청 본문을 보냅니다.

<action>
  <storage_domain id="456"/>
  <disk_profile id="987"/>
  <quota id="753"/>
</action>
Expand
표 6.168. 매개변수 요약
이름유형방향요약

async

부울

in

비동기적으로 이동을 수행할지 여부를 나타냅니다.Indicates if the move should be performed asynchronously.

disk_profile

DiskProfile

in

새 스토리지 도메인의 디스크의 디스크 프로필입니다.

filter

부울

in

사용자의 권한에 따라 결과를 필터링해야 하는지 여부를 나타냅니다.

quota

할당량

in

새 스토리지 도메인의 디스크 할당량입니다.

storage_domain

StorageDomain

in

디스크를 이동할 스토리지 도메인입니다.

6.56.5.1. disk_profile

새 스토리지 도메인의 디스크의 디스크 프로필입니다.

디스크 프로필은 스토리지 도메인에 대해 정의되므로 이전 디스크 프로필이 새 스토리지 도메인에 존재하지 않습니다. 이 매개 변수를 사용하지 않으면 사용자에게 권한이 있는 새 스토리지 도메인의 첫 번째 디스크 프로필이 디스크에 할당됩니다.

6.56.5.2. 할당량

새 스토리지 도메인의 디스크 할당량입니다.

현재 할당량은 새 스토리지 도메인에 대해 정의되지 않을 수 있으므로 이 선택적 매개 변수를 사용하여 디스크에 대한 새 할당량을 지정할 수 있습니다. 이 매개 변수를 사용하지 않고 새 스토리지 도메인에 대해 이전 할당량이 정의되지 않은 경우 default(제한 없음) 할당량이 디스크에 할당됩니다.

6.56.6. POST단축

디스크 이미지의 크기를 줄입니다.

논리 볼륨에서 reduce 를 호출합니다(즉, 블록 스토리지 도메인에만 적용 가능). 이는 비실행 중인 가상 머신에 연결된 유동 디스크 및 디스크에 적용됩니다. 최적 크기가 자동으로 계산되므로 크기를 지정할 필요가 없습니다.

Expand
표 6.169. 매개변수 요약
이름유형방향요약

async

부울

in

제거가 비동기적으로 수행되어야 하는지 여부를 나타냅니다.

6.56.7. refreshlun POST

스토리지의 최신 정보를 사용하여 직접 LUN 디스크를 새로 고칩니다.

직접 LUN 디스크를 새로 고치는 것은 다음과 같은 경우에 유용합니다.

  • LUN은 host 매개 변수 없이 API를 사용하여 추가되었으므로 스토리지의 정보는 포함하지 않습니다( DisksService::add참조).
  • LUN에 대한 새로운 정보는 스토리지에서 사용 가능하며 LUN을 업데이트하려고 합니다.

호스트 456 을 사용하여 직접 LUN 디스크 123 을 새로 고치려면 다음 요청을 보냅니다.

POST /ovirt-engine/api/disks/123/refreshlun

다음과 같은 요청 본문으로:

<action>
  <host id='456'/>
</action>
Expand
표 6.170. 매개변수 요약
이름유형방향요약

host

호스트

in

직접 LUN 디스크를 새로 고치는 데 사용할 호스트입니다.

6.56.8. DELETE제거

디스크를 제거합니다.

Expand
표 6.171. 매개변수 요약
이름유형방향요약

async

부울

in

제거가 비동기적으로 수행되어야 하는지 여부를 나타냅니다.

6.56.9. sparsify POST

디스크를 확장합니다.

스파잉은 파일 시스템에서 사용하지 않는 디스크 이미지의 공간을 확보합니다. 결과적으로 이미지는 저장 공간보다 적은 공간을 차지하게 됩니다.

현재 간격은 스냅샷이 없는 디스크에서만 작동합니다. 파생 디스크를 포함하는 디스크도 허용되지 않습니다.

6.56.10. PUT업데이트

지정된 디스크의 매개변수를 업데이트합니다.

이 작업을 사용하면 다음 유동 디스크 속성을 업데이트할 수 있습니다.

  • 이미지 디스크의 경우 provisioned_size,alias,description,wipe_after_delete,shareable,backupdisk_profile.
  • LUN 디스크의 경우 별칭,설명공유할 수 있습니다.
  • Cinder 통합은 Managed Block Storage로 교체되었습니다.
  • Managed Block 디스크의 경우 provisioned_size,별칭설명.
  • VM 연결 디스크의 경우 qcow_version 도 업데이트할 수 있습니다.

예를 들어 다음 요청을 사용하여 디스크의 업데이트를 수행할 수 있습니다.

PUT /ovirt-engine/api/disks/123

다음과 같이 요청 본문이 있는 경우:

<disk>
  <qcow_version>qcow2_v3</qcow_version>
  <alias>new-alias</alias>
  <description>new-desc</description>
</disk>

백엔드 작업이 비동기적이므로 사용자에게 반환되는 disk 요소가 변경된 속성과 동기화되지 않을 수 있습니다.

Expand
표 6.172. 매개변수 요약
이름유형방향요약

disk

디스크

in/Out

디스크에 적용할 업데이트입니다.

6.57. DiskAttachment

이 서비스는 가상 머신에 대한 디스크 연결을 관리합니다.

Expand
표 6.173. 메서드 요약
이름요약

get

부팅 가능한 플래그 및 디스크 링크를 포함하여 첨부 파일의 세부 정보를 반환합니다.

제거

디스크 연결을 제거합니다.

update

디스크 연결 및 디스크 속성 내에 업데이트합니다.

6.57.1. GET가져오기

부팅 가능한 플래그 및 디스크 링크를 포함하여 첨부 파일의 세부 정보를 반환합니다.

디스크 첨부 파일을 가져오는 예제:

GET /ovirt-engine/api/vms/123/diskattachments/456
<disk_attachment href="/ovirt-engine/api/vms/123/diskattachments/456" id="456">
  <active>true</active>
  <bootable>true</bootable>
  <interface>virtio</interface>
  <disk href="/ovirt-engine/api/disks/456" id="456"/>
  <vm href="/ovirt-engine/api/vms/123" id="123"/>
</disk_attachment>
Expand
표 6.174. 매개변수 요약
이름유형방향요약

첨부 파일

DiskAttachment

Out

 

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

6.57.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.57.2. DELETE제거

디스크 연결을 제거합니다.

이렇게 하면 가상 머신에서 디스크만 분리되지만 detach_only 매개변수가 false 인 경우 시스템에서 제거하지는 않습니다.

디스크 연결 제거의 예:

DELETE /ovirt-engine/api/vms/123/diskattachments/456?detach_only=true
Expand
표 6.175. 매개변수 요약
이름유형방향요약

detach_only

부울

in

디스크를 가상 머신에서 분리해야 하지만 시스템에서 제거하지 않음을 나타냅니다.

6.57.2.1. detach_only

디스크를 가상 머신에서 분리해야 하지만 시스템에서 제거하지 않음을 나타냅니다. 기본값은 시스템에서 디스크를 제거하지 않는 true 입니다.

6.57.3. PUT업데이트

디스크 연결 및 디스크 속성 내에 업데이트합니다.

PUT /vms/{vm:id}/disksattachments/{attachment:id}
<disk_attachment>
  <bootable>true</bootable>
  <interface>ide</interface>
  <active>true</active>
  <disk>
    <name>mydisk</name>
    <provisioned_size>1024</provisioned_size>
    ...
  </disk>
</disk_attachment>
Expand
표 6.176. 매개변수 요약
이름유형방향요약

disk_attachment

DiskAttachment

in/Out

 

6.58. DiskAttachments

이 서비스는 가상 시스템에 연결된 디스크 세트를 관리합니다. 연결된 각 디스크는 부팅 가능한 플래그, 디스크 인터페이스 및 디스크 참조가 포함된 DiskAttachment 로 표시됩니다.

Expand
표 6.177. 메서드 요약
이름요약

add

가상 머신에 새 디스크 연결을 추가합니다.

list

가상 머신에 연결된 디스크를 나열합니다.

6.58.1. POST추가

가상 머신에 새 디스크 연결을 추가합니다. 디스크가 이미 존재하는 경우 attachment 매개변수는 참조만 포함할 수 있습니다.

<disk_attachment>
  <bootable>true</bootable>
  <pass_discard>true</pass_discard>
  <interface>ide</interface>
  <active>true</active>
  <disk id="123"/>
</disk_attachment>

또는 디스크가 아직 존재하지 않는 경우 디스크의 전체 표현을 포함할 수 있습니다.

<disk_attachment>
  <bootable>true</bootable>
  <pass_discard>true</pass_discard>
  <interface>ide</interface>
  <active>true</active>
  <disk>
    <name>mydisk</name>
    <provisioned_size>1024</provisioned_size>
    ...
  </disk>
</disk_attachment>

이 경우 디스크가 생성되고 가상 머신에 연결됩니다.

두 경우 모두 ID 345 가 있는 가상 머신에 대해 다음 URL을 사용합니다.

POST /ovirt-engine/api/vms/345/diskattachments
중요

서버에서는 active 속성이 포함되지 않은 요청을 허용하지만 효과가 정의되지 않습니다. 경우에 따라 디스크가 자동으로 활성화되고 다른 경우에는 활성화되지 않습니다. 문제를 방지하려면 항상 원하는 값과 함께 활성 속성을 포함하는 것이 좋습니다.

Expand
표 6.178. 매개변수 요약
이름유형방향요약

첨부 파일

DiskAttachment

in/Out

가상 머신에 추가할 디스크 연결입니다.

6.58.2. GET나열

가상 머신에 연결된 디스크를 나열합니다.

디스크 첨부 파일의 반환 목록 순서는 보장되지 않습니다.

Expand
표 6.179. 매개변수 요약
이름유형방향요약

첨부 파일

DiskAttachment[]

Out

가상 머신에 연결된 디스크 연결 목록입니다.

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

6.58.2.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.59. DiskProfile

Expand
표 6.180. 메서드 요약
이름요약

get

 

제거

 

update

시스템에서 지정된 디스크 프로필을 업데이트합니다.

6.59.1. GET가져오기

Expand
표 6.181. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

profile

DiskProfile

Out

 
6.59.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.59.2. DELETE제거

Expand
표 6.182. 매개변수 요약
이름유형방향요약

async

부울

in

제거가 비동기적으로 수행되어야 하는지 여부를 나타냅니다.

6.59.3. PUT업데이트

시스템에서 지정된 디스크 프로필을 업데이트합니다.

Expand
표 6.183. 매개변수 요약
이름유형방향요약

async

부울

in

업데이트를 비동기적으로 수행해야 하는지 여부를 나타냅니다.

profile

DiskProfile

in/Out

 

6.60. DiskProfiles

Expand
표 6.184. 메서드 요약
이름요약

add

시스템에 새 디스크 프로필을 추가합니다.

list

시스템의 디스크 프로필 목록을 반환합니다.

6.60.1. POST추가

시스템에 새 디스크 프로필을 추가합니다.

Expand
표 6.185. 매개변수 요약
이름유형방향요약

profile

DiskProfile

in/Out

 

6.60.2. GET나열

시스템의 디스크 프로필 목록을 반환합니다.

디스크 프로필의 반환된 목록의 순서는 보장되지 않습니다.

Expand
표 6.186. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 최대 프로필 수를 설정합니다.

profile

DiskProfile[]

Out

 
6.60.2.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.60.2.2. max

반환할 최대 프로필 수를 설정합니다. 지정하지 않으면 모든 프로필이 반환됩니다.

6.61. DiskSnapshot

Expand
표 6.187. 메서드 요약
이름요약

get

 

제거

 

6.61.1. GET가져오기

Expand
표 6.188. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

snapshot

DiskSnapshot

Out

 
6.61.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.61.2. DELETE제거

Expand
표 6.189. 매개변수 요약
이름유형방향요약

async

부울

in

제거가 비동기적으로 수행되어야 하는지 여부를 나타냅니다.

6.62. DiskSnapshots

스토리지 도메인에서 사용 가능한 디스크 스냅샷 컬렉션을 관리합니다.

Expand
표 6.190. 메서드 요약
이름요약

list

스토리지 도메인의 디스크 스냅샷 목록을 반환합니다.

6.62.1. GET나열

스토리지 도메인의 디스크 스냅샷 목록을 반환합니다.

반환된 디스크 스냅샷 목록의 순서는 보장되지 않습니다.

Expand
표 6.191. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

include_active

부울

in

true를 반환하는 경우 활성 스냅샷도 반환됩니다.

include_template

부울

in

true에서 템플릿 스냅샷도 반환하는 경우.

max

정수

in

반환할 최대 스냅샷 수를 설정합니다.

snapshots

DiskSnapshot[]

Out

 
6.62.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.62.1.2. include_active

true를 반환하는 경우 활성 스냅샷도 반환됩니다. 지정되지 않은 경우 활성 스냅샷이 반환되지 않습니다.

6.62.1.3. include_template

true에서 템플릿 스냅샷도 반환하는 경우. 지정된 템플릿 스냅샷이 반환되지 않는 경우.

6.62.1.4. max

반환할 최대 스냅샷 수를 설정합니다. 지정하지 않으면 모든 스냅샷이 반환됩니다.

6.63. 디스크

시스템에서 사용 가능한 디스크 컬렉션을 관리합니다.

Expand
표 6.192. 메서드 요약
이름요약

add

새 유동 디스크를 추가합니다.

list

디스크 목록을 가져옵니다.

6.63.1. POST추가

새 유동 디스크를 추가합니다.

디스크 이미지, 직접 LUN 및 관리형 블록 디스크 등 3가지 유형의 디스크를 추가할 수 있습니다. Cinder 통합은 Managed Block Storage로 교체되었습니다.

새 이미지 디스크 추가:

새 부동 이미지 디스크 를 생성할 때 API에는 storage_domain,provisioned_sizeformat 속성이 필요합니다.

iSCSI 또는 FCP의 스토리지 유형을 사용하는 블록 스토리지 도메인은 스파스=true와 원시 형식 의 조합을 지원하지 않으므로 sparse= false 를 명시적으로 지정해야 합니다.

지정된 provisioned_size,포맷이름을 사용하여 새 유동 이미지 디스크를 생성하려면 ID가 123 이고 증분 백업에 대해 활성화된 스토리지 도메인에서 다음과 같이 요청을 보냅니다.

POST /ovirt-engine/api/disks

다음과 같이 요청 본문을 사용합니다.

<disk>
  <storage_domains>
    <storage_domain id="123"/>
  </storage_domains>
  <name>mydisk</name>
  <provisioned_size>1048576</provisioned_size>
  <format>cow</format>
  <backup>incremental</backup>
</disk>

새로운 직접 LUN 디스크를 추가합니다.

API를 통해 새 유동 LUN을 추가할 때 사용할 수 있는 두 가지 플레이버가 있습니다.

  1. 호스트 요소 사용 - 이 경우 호스트는 온전성 검사(예: LUN이 표시됨)에 사용되고 LUN(예: 크기 및 직렬)에 대한 기본 정보를 검색합니다.
  2. 호스트 요소 없음 - 이 경우 작업은 데이터베이스 전용 작업이며 스토리지에 액세스하지 않습니다.

id 123, 지정된 별칭,typelogical_unit 을 사용하여 id 456 (속성 주소,포트대상)을 사용하여 호스트 요소를 사용하여 새 부동 직접 LUN 디스크를 생성하려면 다음과 같이 요청을 보냅니다.

POST /ovirt-engine/api/disks

다음과 같이 요청 본문을 사용합니다.

<disk>
  <alias>mylun</alias>
  <lun_storage>
    <host id="123"/>
    <type>iscsi</type>
    <logical_units>
      <logical_unit id="456">
        <address>10.35.10.20</address>
        <port>3260</port>
        <target>iqn.2017-01.com.myhost:444</target>
      </logical_unit>
    </logical_units>
  </lun_storage>
</disk>

호스트를 사용하지 않고 새 유동 LUN 디스크를 만들려면 host 요소를 제거합니다.

새 Cinder 디스크를 추가합니다.

Cinder 통합은 Managed Block Storage로 교체되었습니다.

디스크 스냅샷을 업로드하기 위해 유동 디스크를 추가합니다.

엔진의 버전 4.2부터 스냅샷으로 디스크를 업로드할 수 있습니다. 이 요청은 이미지 체인의 기본 이미지(스냅 샷 생성 시 disk-attachments 요소)를 사용하여 생성해야 합니다.

디스크는 업로드된 이미지의 동일한 디스크 식별자와 이미지 식별자를 사용하여 생성해야 합니다. 즉, 식별자는 백업 프로세스의 일부로 저장해야 합니다. 이미지 식별자는 qemu-img info 명령을 사용하여 가져올 수도 있습니다. 예를 들어 디스크 이미지가 b7a4c6c5-443b-47c5-967f-6abc79675e8b/myimage.img 라는 파일에 저장된 경우:

$ qemu-img info b7a4c6c5-443b-47c5-967f-6abc79675e8b/myimage.img
image: b548366b-fb51-4b41-97be-733c887fe305
file format: qcow2
virtual size: 1.0G (1073741824 bytes)
disk size: 196K
cluster_size: 65536
backing file: ad58716a-1fe9-481f-815e-664de1df04eb
backing file format: raw

위에 표시된 qemu-img info 명령으로 얻은 디스크 식별자 및 이미지 식별자를 사용하여 디스크를 생성하려면 다음과 같은 요청을 보냅니다.

POST /ovirt-engine/api/disks

다음과 같이 요청 본문을 사용합니다.

<disk id="b7a4c6c5-443b-47c5-967f-6abc79675e8b">
  <image_id>b548366b-fb51-4b41-97be-733c887fe305</image_id>
  <storage_domains>
    <storage_domain id="123"/>
  </storage_domains>
  <name>mydisk</name>
  <provisioned_size>1048576</provisioned_size>
  <format>cow</format>
</disk>
Expand
표 6.193. 매개변수 요약
이름유형방향요약

disk

디스크

in/Out

디스크입니다.

6.63.2. GET나열

디스크 목록을 가져옵니다.

GET /ovirt-engine/api/disks

다음과 같은 XML 응답이 표시됩니다.

<disks>
  <disk id="123">
    <actions>...</actions>
    <name>MyDisk</name>
    <description>MyDisk description</description>
    <link href="/ovirt-engine/api/disks/123/permissions" rel="permissions"/>
    <link href="/ovirt-engine/api/disks/123/statistics" rel="statistics"/>
    <actual_size>5345845248</actual_size>
    <alias>MyDisk alias</alias>
    ...
    <status>ok</status>
    <storage_type>image</storage_type>
    <wipe_after_delete>false</wipe_after_delete>
    <disk_profile id="123"/>
    <quota id="123"/>
    <storage_domains>...</storage_domains>
  </disk>
  ...
</disks>

반환된 디스크 목록의 순서는 sortby 절이 검색 매개 변수에 포함된 경우에만 보장됩니다.

Expand
표 6.194. 매개변수 요약
이름유형방향요약

case_sensitive

부울

in

검색 매개 변수를 사용하여 수행된 검색이 대소문자를 고려하여 수행해야 하는지 여부를 나타냅니다.

디스크

Disk[]

Out

검색된 디스크 목록.

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 최대 디스크 수를 설정합니다.

search

문자열

in

반환된 디스크를 제한하는 데 사용되는 쿼리 문자열입니다.

6.63.2.1. case_sensitive

검색 매개 변수를 사용하여 수행된 검색이 대소문자를 고려하여 수행해야 하는지 여부를 나타냅니다. 기본값은 true 입니다. 즉, 해당 케이스가 고려됩니다. 대소문자를 무시하고자 하는 경우 false 로 설정합니다.

6.63.2.2. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.63.2.3. max

반환할 최대 디스크 수를 설정합니다. 지정하지 않으면 모든 디스크가 반환됩니다.

6.64. domain

시스템의 인증 도메인 세부 정보를 확인하는 서비스입니다.

Expand
표 6.195. 메서드 요약
이름요약

get

인증 도메인 정보를 가져옵니다.

6.64.1. GET가져오기

인증 도메인 정보를 가져옵니다.

사용법:

GET /ovirt-engine/api/domains/5678

는 도메인 정보를 반환합니다.

<domain href="/ovirt-engine/api/domains/5678" id="5678">
  <name>internal-authz</name>
  <link href="/ovirt-engine/api/domains/5678/users" rel="users"/>
  <link href="/ovirt-engine/api/domains/5678/groups" rel="groups"/>
  <link href="/ovirt-engine/api/domains/5678/users?search={query}" rel="users/search"/>
  <link href="/ovirt-engine/api/domains/5678/groups?search={query}" rel="groups/search"/>
</domain>
Expand
표 6.196. 매개변수 요약
이름유형방향요약

domain

domain

Out

인증 도메인입니다.

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

6.64.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.65. DomainGroup

Expand
표 6.197. 메서드 요약
이름요약

get

 

6.65.1. GET가져오기

Expand
표 6.198. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

get

그룹

Out

 
6.65.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.66. DomainGroups

Expand
표 6.199. 메서드 요약
이름요약

list

그룹 목록을 반환합니다.

6.66.1. GET나열

그룹 목록을 반환합니다.

반환된 그룹 목록의 순서는 보장되지 않습니다.

Expand
표 6.200. 매개변수 요약
이름유형방향요약

case_sensitive

부울

in

검색 매개 변수를 사용하여 수행된 검색이 대소문자를 고려하여 수행해야 하는지 여부를 나타냅니다.

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

groups

그룹 []

Out

 

max

정수

in

반환할 최대 그룹 수를 설정합니다.

search

문자열

in

반환된 그룹을 제한하는 데 사용되는 쿼리 문자열입니다.

6.66.1.1. case_sensitive

검색 매개 변수를 사용하여 수행된 검색이 대소문자를 고려하여 수행해야 하는지 여부를 나타냅니다. 기본값은 true 입니다. 즉, 해당 케이스가 고려됩니다. 대소문자를 무시하고자 하는 경우 false 로 설정합니다.

6.66.1.2. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.66.1.3. max

반환할 최대 그룹 수를 설정합니다. 지정하지 않으면 모든 그룹이 반환됩니다.

6.67. DomainUser

시스템에서 도메인 사용자를 보는 서비스입니다.

Expand
표 6.201. 메서드 요약
이름요약

get

도메인 사용자 정보를 가져옵니다.

6.67.1. GET가져오기

도메인 사용자 정보를 가져옵니다.

사용법:

GET /ovirt-engine/api/domains/5678/users/1234

는 도메인 사용자 정보를 반환합니다.

<user href="/ovirt-engine/api/users/1234" id="1234">
  <name>admin</name>
  <namespace>*</namespace>
  <principal>admin</principal>
  <user_name>admin@internal-authz</user_name>
  <domain href="/ovirt-engine/api/domains/5678" id="5678">
    <name>internal-authz</name>
  </domain>
  <groups/>
</user>
Expand
표 6.202. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

user

사용자

Out

도메인 사용자입니다.

6.67.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.68. DomainUserGroups

AAA 확장에서 사용자의 그룹 멤버십을 보여주는 서비스입니다.

Expand
표 6.203. 메서드 요약
이름요약

list

사용자가 멤버인 그룹 목록을 반환합니다.

6.68.1. GET나열

사용자가 멤버인 그룹 목록을 반환합니다.

Expand
표 6.204. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

groups

그룹 []

Out

사용자가 멤버인 그룹 목록입니다.

6.68.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.69. DomainUsers

시스템의 모든 도메인 사용자를 나열하는 서비스입니다.

Expand
표 6.205. 메서드 요약
이름요약

list

도메인의 모든 사용자를 나열합니다.

6.69.1. GET나열

도메인의 모든 사용자를 나열합니다.

사용법:

GET /ovirt-engine/api/domains/5678/users

는 도메인의 사용자 목록을 반환합니다.

<users>
  <user href="/ovirt-engine/api/domains/5678/users/1234" id="1234">
    <name>admin</name>
    <namespace>*</namespace>
    <principal>admin</principal>
    <user_name>admin@internal-authz</user_name>
    <domain href="/ovirt-engine/api/domains/5678" id="5678">
      <name>internal-authz</name>
    </domain>
    <groups/>
  </user>
</users>

반환된 사용자 목록의 순서는 보장되지 않습니다.

Expand
표 6.206. 매개변수 요약
이름유형방향요약

case_sensitive

부울

in

검색 매개 변수를 사용하여 수행된 검색이 대소문자를 고려하여 수행해야 하는지 여부를 나타냅니다.

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 최대 사용자 수를 설정합니다.

search

문자열

in

반환된 사용자를 제한하는 데 사용되는 쿼리 문자열입니다.

사용자

사용자 []

Out

도메인의 사용자 목록입니다.

6.69.1.1. case_sensitive

검색 매개 변수를 사용하여 수행된 검색이 대소문자를 고려하여 수행해야 하는지 여부를 나타냅니다. 기본값은 true 입니다. 즉, 해당 케이스가 고려됩니다. 대소문자를 무시하고자 하는 경우 false 로 설정합니다.

6.69.1.2. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.69.1.3. max

반환할 최대 사용자 수를 설정합니다. 지정하지 않으면 모든 사용자가 반환됩니다.

6.70. domain

시스템의 모든 인증 도메인을 나열하는 서비스입니다.

Expand
표 6.207. 메서드 요약
이름요약

list

시스템의 모든 인증 도메인을 나열합니다.

6.70.1. GET나열

시스템의 모든 인증 도메인을 나열합니다.

사용법:

GET /ovirt-engine/api/domains

는 도메인 목록을 반환합니다.

<domains>
  <domain href="/ovirt-engine/api/domains/5678" id="5678">
    <name>internal-authz</name>
    <link href="/ovirt-engine/api/domains/5678/users" rel="users"/>
    <link href="/ovirt-engine/api/domains/5678/groups" rel="groups"/>
    <link href="/ovirt-engine/api/domains/5678/users?search={query}" rel="users/search"/>
    <link href="/ovirt-engine/api/domains/5678/groups?search={query}" rel="groups/search"/>
  </domain>
</domains>

반환된 도메인 목록의 순서는 보장되지 않습니다.

Expand
표 6.208. 매개변수 요약
이름유형방향요약

domain

domain []

Out

도메인 목록입니다.

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 최대 도메인 수를 설정합니다.

6.70.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.70.1.2. max

반환할 최대 도메인 수를 설정합니다. 지정하지 않으면 모든 도메인이 반환됩니다.

6.71. EngineKatelloErrata

엔진에 할당된 Katello 에라타를 관리하는 서비스입니다. 해당 정보는 Katello에서 검색됩니다.

Expand
표 6.209. 메서드 요약
이름요약

list

Katello 에라타의 표현을 검색합니다.

6.71.1. GET나열

Katello 에라타의 표현을 검색합니다.

GET /ovirt-engine/api/katelloerrata

다음과 같은 XML로 응답을 받습니다.

<katello_errata>
  <katello_erratum href="/ovirt-engine/api/katelloerrata/123" id="123">
    <name>RHBA-2013:XYZ</name>
    <description>The description of the erratum</description>
    <title>some bug fix update</title>
    <type>bugfix</type>
    <issued>2013-11-20T02:00:00.000+02:00</issued>
    <solution>Few guidelines regarding the solution</solution>
    <summary>Updated packages that fix one bug are now available for XYZ</summary>
    <packages>
      <package>
        <name>libipa_hbac-1.9.2-82.11.el6_4.i686</name>
      </package>
      ...
    </packages>
  </katello_erratum>
  ...
</katello_errata>

반환된 에라타 목록의 순서는 보장되지 않습니다.

Expand
표 6.210. 매개변수 요약
이름유형방향요약

errata

KatelloErratum[]

Out

Katello 에라타의 표현입니다.

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 최대 에라타 수를 설정합니다.

6.71.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.71.1.2. max

반환할 최대 에라타 수를 설정합니다. 지정하지 않으면 에라타가 모두 반환됩니다.

6.72. 이벤트

시스템에서 이벤트를 관리하는 서비스입니다.

Expand
표 6.211. 메서드 요약
이름요약

get

이벤트를 가져옵니다.

제거

내부 감사 로그에서 이벤트를 제거합니다.

6.72.1. GET가져오기

이벤트를 가져옵니다.

이벤트를 가져오는 예제:

GET /ovirt-engine/api/events/123
<event href="/ovirt-engine/api/events/123" id="123">
  <description>Host example.com was added by admin@internal-authz.</description>
  <code>42</code>
  <correlation_id>135</correlation_id>
  <custom_id>-1</custom_id>
  <flood_rate>30</flood_rate>
  <origin>oVirt</origin>
  <severity>normal</severity>
  <time>2016-12-11T11:13:44.654+02:00</time>
  <cluster href="/ovirt-engine/api/clusters/456" id="456"/>
  <host href="/ovirt-engine/api/hosts/789" id="789"/>
  <user href="/ovirt-engine/api/users/987" id="987"/>
</event>

이벤트에 상주하는 정보에 따라 필드 수가 변경됩니다. 예를 들어 스토리지 도메인 관련 이벤트의 경우 이 스토리지 도메인이 상주하는 데이터 센터에 대한 참조와 스토리지 도메인 참조를 가져옵니다.

Expand
표 6.212. 매개변수 요약
이름유형방향요약

event

이벤트

Out

 

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

6.72.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.72.2. DELETE제거

내부 감사 로그에서 이벤트를 제거합니다.

다음 요청을 전송하여 이벤트를 제거할 수 있습니다.

DELETE /ovirt-engine/api/events/123
Expand
표 6.213. 매개변수 요약
이름유형방향요약

async

부울

in

제거가 비동기적으로 수행되어야 하는지 여부를 나타냅니다.

6.73. EventSubscription

시스템에서 특정 이벤트 서브스크립션을 관리하는 서비스입니다.

Expand
표 6.214. 메서드 요약
이름요약

get

event-subscription에 대한 정보를 가져옵니다.

제거

시스템에서 event-subscription를 제거합니다.

6.73.1. GET가져오기

event-subscription에 대한 정보를 가져옵니다.

예를 들어 '123' 사용자의 서브스크립션에 대한 정보를 'vm_console_detected' 이벤트로 검색하려면 다음을 수행합니다.

GET /ovirt-engine/api/users/123/vm_console_detected
<event-subscription href="/ovirt-engine/api/users/123/event-subscriptions/vm_console_detected">
  <event>vm_console_detected</event>
  <notification_method>smtp</notification_method>
  <user href="/ovirt-engine/api/users/123" id="123"/>
  <address>a@b.com</address>
</event-subscription>
Expand
표 6.215. 매개변수 요약
이름유형방향요약

event_subscription

EventSubscription

Out

event-subscription.

6.73.2. DELETE제거

시스템에서 event-subscription를 제거합니다.

예를 들어 사용자 123의 서브스크립션에서 vm_console_detected 이벤트를 제거하려면 다음을 수행합니다.

DELETE /ovirt-engine/api/users/123/vm_console_detected
Expand
표 6.216. 매개변수 요약
이름유형방향요약

async

부울

in

제거가 비동기적으로 수행되어야 하는지 여부를 나타냅니다.

6.74. EventSubscriptions

사용자의 이벤트 서브스크립션 컬렉션을 관리하는 서비스를 나타냅니다.

Expand
표 6.217. 메서드 요약
이름요약

add

시스템에 새 event-subscription를 추가합니다.

list

제공된 사용자의 이벤트 서브스크립션을 나열합니다.

6.74.1. POST추가

시스템에 새 event-subscription를 추가합니다.

이벤트 구독은 항상 사용자 컨텍스트에서 추가됩니다.An event-subscription is always added in the context of a user. 예를 들어 사용자 123 에 대해 host_high_cpu_use 에 대한 새 event-subscription를 추가하고 이메일 주소로 알림이 전송되도록 하려면 다음과 같은 요청을 보냅니다.

POST /ovirt-engine/api/users/123/eventsubscriptions

다음과 같이 요청 본문이 있는 경우:

<event_subscription>
    <event>host_high_cpu_use</event>
    <address>a@b.com</address>
</event_subscription>

이벤트 이름은 새 event-subscription 엔티티의 ID가 됩니다. GET …​/api/users/123/eventsubscriptions/host_high_cpu_use

요청 본문에 사용자 ID가 제공되지 않습니다. 이는 사용자 ID(이 경우 123)가 컨텍스트에서 API에 이미 알려져 있기 때문입니다. 또한 event-subscription 엔터티에 notification-method 필드가 포함되어 있지만 요청 본문에는 제공되지 않습니다. 현재 항상 SNMP 알림으로 설정되어 있는 것은 API 계층에서 지원되지 않기 때문입니다.

Expand
표 6.218. 매개변수 요약
이름유형방향요약

event_subscription

EventSubscription

in/Out

추가된 event-subscription.

6.74.2. GET나열

제공된 사용자의 이벤트 서브스크립션을 나열합니다.

예를 들어 사용자 123 의 event-subscriptions를 나열하려면 다음을 수행합니다.

GET /ovirt-engine/api/users/123/event-subscriptions
<event-subscriptions>
  <event-subscription href="/ovirt-engine/api/users/123/event-subscriptions/host_install_failed">
    <event>host_install_failed</event>
    <notification_method>smtp</notification_method>
    <user href="/ovirt-engine/api/users/123" id="123"/>
    <address>a@b.com</address>
  </event-subscription>
  <event-subscription href="/ovirt-engine/api/users/123/event-subscriptions/vm_paused">
    <event>vm_paused</event>
    <notification_method>smtp</notification_method>
    <user href="/ovirt-engine/api/users/123" id="123"/>
    <address>a@b.com</address>
  </event-subscription>
</event-subscriptions>
Expand
표 6.219. 매개변수 요약
이름유형방향요약

event_subscriptions

EventSubscription[]

Out

지정된 사용자의 이벤트 서브스크립션 목록

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 이벤트 서브스크립션의 최대 수를 설정합니다.

6.74.2.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.74.2.2. max

반환할 이벤트 서브스크립션의 최대 수를 설정합니다. 지정하지 않으면 모든 event-subscriptions가 반환됩니다.

6.75. 이벤트

시스템에서 이벤트를 관리하는 서비스입니다.

Expand
표 6.220. 메서드 요약
이름요약

add

내부 감사 로그에 외부 이벤트를 추가합니다.

list

이벤트 목록을 가져옵니다.

삭제 취소

 

6.75.1. POST추가

내부 감사 로그에 외부 이벤트를 추가합니다.

이는 시스템 관리자와 관련된 이벤트를 감지하거나 생성하는 외부 시스템과 통합하기 위한 것입니다. 예를 들어 외부 모니터링 툴에서 파일 시스템이 가상 머신의 게스트 운영 체제 내부에서 파일 시스템이 가득다는 것을 감지할 수 있습니다. 이 이벤트는 다음과 같이 요청을 보내는 내부 감사 로그에 추가할 수 있습니다.

POST /ovirt-engine/api/events
<event>
  <description>File system /home is full</description>
  <severity>alert</severity>
  <origin>mymonitor</origin>
  <custom_id>1467879754</custom_id>
</event>

이벤트는 특정 오브젝트에도 연결할 수 있습니다. 예를 들어 위의 이벤트는 vm 링크를 사용하여 발생한 특정 가상 머신에 연결할 수 있습니다.

POST /ovirt-engine/api/events
<event>
  <description>File system /home is full</description>
  <severity>alert</severity>
  <origin>mymonitor</origin>
  <custom_id>1467879754</custom_id>
  <vm id="aae98225-5b73-490d-a252-899209af17e9"/>
</event>
참고

이전 예에서 vm 와 같은 링크를 사용하는 경우 id 속성만 허용됩니다. name 속성(제공되는 경우)은 무시됩니다.

Expand
표 6.221. 매개변수 요약
이름유형방향요약

event

이벤트

in/Out

 

6.75.2. GET나열

이벤트 목록을 가져옵니다.

GET /ovirt-engine/api/events

위의 요청에 따라 다음과 같은 응답이 제공됩니다.

<events>
  <event href="/ovirt-engine/api/events/2" id="2">
    <description>User admin@internal-authz logged out.</description>
    <code>31</code>
    <correlation_id>1e892ea9</correlation_id>
    <custom_id>-1</custom_id>
    <flood_rate>30</flood_rate>
    <origin>oVirt</origin>
    <severity>normal</severity>
    <time>2016-09-14T12:14:34.541+02:00</time>
    <user href="/ovirt-engine/api/users/57d91d48-00da-0137-0138-000000000244" id="57d91d48-00da-0137-0138-000000000244"/>
  </event>
  <event href="/ovirt-engine/api/events/1" id="1">
    <description>User admin logged in.</description>
    <code>30</code>
    <correlation_id>1fbd81f4</correlation_id>
    <custom_id>-1</custom_id>
    <flood_rate>30</flood_rate>
    <origin>oVirt</origin>
    <severity>normal</severity>
    <time>2016-09-14T11:54:35.229+02:00</time>
    <user href="/ovirt-engine/api/users/57d91d48-00da-0137-0138-000000000244" id="57d91d48-00da-0137-0138-000000000244"/>
  </event>
</events>

다음 이벤트가 발생합니다.

  • id="1" - API 로그입니다.
  • id="2" - API 로그가 admin 사용자 계정에서 로그아웃합니다.

반환된 이벤트 목록의 순서는 항상 표시됩니다. sortby 절이 search 매개변수에 포함된 경우 이벤트는 해당 절에 따라 정렬됩니다. sortby 절이 포함되지 않은 경우 이벤트는 가장 높은 값부터 시작하여 id 특성의 숫자 값에 따라 정렬됩니다. max 매개변수와 결합하여 최신 이벤트를 쉽게 얻을 수 있습니다.

GET /ovirt-engine/api/events?max=1
Expand
표 6.222. 매개변수 요약
이름유형방향요약

case_sensitive

부울

in

검색 매개 변수를 사용하여 수행된 검색이 대소문자를 고려하여 수행해야 하는지 여부를 나타냅니다.

events

Event[]

Out

 

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

from

정수

in

이벤트를 반환해야 하는 후 이벤트 인덱스를 나타냅니다.Indicates the event index after which events should be returned.

max

정수

in

반환할 최대 이벤트 수를 설정합니다.

search

문자열

in

events 서비스는 다른 리소스 서비스와 유사한 검색 쿼리를 제공합니다.

6.75.2.1. case_sensitive

검색 매개 변수를 사용하여 수행된 검색이 대소문자를 고려하여 수행해야 하는지 여부를 나타냅니다. 기본값은 true 입니다. 즉, 해당 케이스가 고려됩니다. 대소문자를 무시하고자 하는 경우 false 로 설정합니다.

6.75.2.2. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.75.2.3. from

이벤트를 반환해야 하는 후 이벤트 인덱스를 나타냅니다.Indicates the event index after which events should be returned. 이벤트 인덱스는 엄격하게 증가하므로 이 매개 변수가 더 큰 인덱스를 갖는 이벤트만 반환됩니다. 예를 들어 다음 요청은 인덱스가 123 보다 큰 이벤트만 반환합니다.

GET /ovirt-engine/api/events?from=123

이 매개변수는 선택 사항이며 지정되지 않은 경우 반환된 첫 번째 이벤트가 가장 최근에 생성됩니다.

6.75.2.4. max

반환할 최대 이벤트 수를 설정합니다. 지정하지 않으면 모든 이벤트가 반환됩니다.

6.75.3. 삭제 취소 POST

Expand
표 6.223. 매개변수 요약
이름유형방향요약

async

부울

in

삭제 취소를 비동기적으로 수행해야 하는지 여부를 나타냅니다.Indicates if the un-delete should be performed asynchronously.

6.76. ExternalComputeResource

단일 외부 컴퓨팅 리소스를 관리합니다.

컴퓨팅 리소스는 호스트 외부 공급업체라는 용어입니다. 외부 공급자는 프로비저닝된 호스트를 등록해야 하는 위치도 알아야 합니다. 엔진의 로그인 세부 정보는 외부 공급자 측에서 컴퓨팅 리소스로 저장됩니다.

Expand
표 6.224. 메서드 요약
이름요약

get

외부 컴퓨팅 리소스 세부 정보를 검색합니다.

6.76.1. GET가져오기

외부 컴퓨팅 리소스 세부 정보를 검색합니다.

예를 들어, 컴퓨팅 리소스( 123 )의 컴퓨팅 리소스( 234 )에 대한 세부 정보를 얻으려면 다음과 같은 요청을 보내라.

GET /ovirt-engine/api/externalhostproviders/123/computeresources/234

다음과 같은 응답을 반환합니다.

<external_compute_resource href="/ovirt-engine/api/externalhostproviders/123/computeresources/234" id="234">
  <name>hostname</name>
  <provider>oVirt</provider>
  <url>https://hostname/api</url>
  <user>admin@internal</user>
  <external_host_provider href="/ovirt-engine/api/externalhostproviders/123" id="123"/>
</external_compute_resource>
Expand
표 6.225. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

resource

ExternalComputeResource

Out

외부 컴퓨팅 리소스 정보

6.76.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.77. ExternalComputeResources

외부 컴퓨팅 리소스의 컬렉션을 관리합니다.

컴퓨팅 리소스는 호스트 외부 공급업체라는 용어입니다. 외부 공급자는 프로비저닝된 호스트를 등록해야 하는 위치도 알아야 합니다. 엔진의 로그인 세부 정보는 외부 공급자 측에서 컴퓨팅 리소스로 저장됩니다.

Expand
표 6.226. 메서드 요약
이름요약

list

외부 컴퓨팅 리소스 목록을 검색합니다.

6.77.1. GET나열

외부 컴퓨팅 리소스 목록을 검색합니다.

예를 들어 외부 호스트 공급자 123 의 컴퓨팅 리소스를 검색하려면 다음과 같은 요청을 보냅니다.

GET /ovirt-engine/api/externalhostproviders/123/computeresources

다음과 같은 응답을 반환합니다.

<external_compute_resources>
  <external_compute_resource href="/ovirt-engine/api/externalhostproviders/123/computeresources/234" id="234">
    <name>hostname</name>
    <provider>oVirt</provider>
    <url>https://address/api</url>
    <user>admin@internal</user>
    <external_host_provider href="/ovirt-engine/api/externalhostproviders/123" id="123"/>
   </external_compute_resource>
   ...
</external_compute_resources>

반환된 컴퓨팅 리소스 목록의 순서는 보장되지 않습니다.

Expand
표 6.227. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 최대 리소스 수를 설정합니다.

resources

ExternalComputeResource[]

Out

외부 컴퓨터 리소스 목록입니다.

6.77.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.77.1.2. max

반환할 최대 리소스 수를 설정합니다. 지정하지 않으면 모든 리소스가 반환됩니다.

6.78. ExternalDiscoveredHost

이 서비스는 발견된 단일 호스트를 관리합니다.

Expand
표 6.228. 메서드 요약
이름요약

get

호스트 정보를 검색합니다.

6.78.1. GET가져오기

호스트 정보를 검색합니다.

Foreman과 같은 외부 공급자 관리 시스템에서 관리하는 호스트에 대한 정보를 검색합니다. 정보에는 호스트 이름, 주소, 서브넷, 기본 이미지 등이 포함됩니다.

예를 들어 공급자 123 에서 호스트 234 의 세부 정보를 얻으려면 다음과 같은 요청을 보냅니다.

GET /ovirt-engine/api/externalhostproviders/123/discoveredhosts/234

결과는 다음과 같습니다.

<external_discovered_host href="/ovirt-engine/api/externalhostproviders/123/discoveredhosts/234" id="234">
 <name>mac001a4ad04040</name>
 <ip>10.34.67.43</ip>
 <last_report>2017-04-24 11:05:41 UTC</last_report>
 <mac>00:1a:4a:d0:40:40</mac>
 <subnet_name>sat0</subnet_name>
 <external_host_provider href="/ovirt-engine/api/externalhostproviders/123" id="123"/>
</external_discovered_host>
Expand
표 6.229. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

host

ExternalDiscoveredHost

Out

호스트의 하드웨어 및 구성 정보.

6.78.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.79. ExternalDiscoveredHosts

이 서비스는 발견된 외부 호스트를 관리합니다.

Expand
표 6.230. 메서드 요약
이름요약

list

검색된 호스트 정보 목록을 가져옵니다.

6.79.1. GET나열

검색된 호스트 정보 목록을 가져옵니다.

검색된 호스트는 Foreman과 같은 타사 공급업체에서 가져옵니다.

공급자 123 에 대해 검색된 모든 호스트를 나열하려면 다음을 보냅니다.

GET /ovirt-engine/api/externalhostproviders/123/discoveredhost
<external_discovered_hosts>
 <external_discovered_host href="/ovirt-engine/api/externalhostproviders/123/discoveredhosts/456" id="456">
  <name>mac001a4ad04031</name>
  <ip>10.34.67.42</ip>
  <last_report>2017-04-24 11:05:41 UTC</last_report>
  <mac>00:1a:4a:d0:40:31</mac>
  <subnet_name>sat0</subnet_name>
  <external_host_provider href="/ovirt-engine/api/externalhostproviders/123" id="123"/>
 </external_discovered_host>
 <external_discovered_host href="/ovirt-engine/api/externalhostproviders/123/discoveredhosts/789" id="789">
  <name>mac001a4ad04040</name>
  <ip>10.34.67.43</ip>
  <last_report>2017-04-24 11:05:41 UTC</last_report>
  <mac>00:1a:4a:d0:40:40</mac>
  <subnet_name>sat0</subnet_name>
  <external_host_provider href="/ovirt-engine/api/externalhostproviders/123" id="123"/>
 </external_discovered_host>
 ...
</external_discovered_hosts>

반환된 호스트 목록의 순서는 보장되지 않습니다.

Expand
표 6.231. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

호스트

ExternalDiscoveredHost[]

Out

검색된 호스트 목록

max

정수

in

반환할 최대 호스트 수를 설정합니다.

6.79.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.79.1.2. max

반환할 최대 호스트 수를 설정합니다. 지정하지 않으면 모든 호스트가 반환됩니다.

6.80. ExternalHost

Expand
표 6.232. 메서드 요약
이름요약

get

 

6.80.1. GET가져오기

Expand
표 6.233. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

host

ExternalHost

Out

 
6.80.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.81. ExternalHostGroup

이 서비스는 단일 호스트 그룹 정보를 관리합니다.

호스트 그룹은 호스트 공급자라는 용어입니다. 호스트 그룹에는 검색된 새 호스트에 적용되는 프로비저닝 세부 정보가 포함됩니다. 서브넷, 운영 체제, 도메인 등의 정보

Expand
표 6.234. 메서드 요약
이름요약

get

호스트 그룹 정보를 가져옵니다.

6.81.1. GET가져오기

호스트 그룹 정보를 가져옵니다.

예를 들어, 공급자( 123 )의 호스트 그룹( 234 )에 대한 세부 정보를 얻으려면 다음과 같은 요청을 보내라.

GET /ovirt-engine/api/externalhostproviders/123/hostgroups/234

다음과 같은 응답을 반환합니다.

<external_host_group href="/ovirt-engine/api/externalhostproviders/123/hostgroups/234" id="234">
  <name>rhel7</name>
  <architecture_name>x86_64</architecture_name>
  <domain_name>s.com</domain_name>
  <operating_system_name>RedHat 7.3</operating_system_name>
  <subnet_name>sat0</subnet_name>
  <external_host_provider href="/ovirt-engine/api/externalhostproviders/123" id="123"/>
</external_host_group>
Expand
표 6.235. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

group

ExternalHostGroup

Out

호스트 그룹 정보.

6.81.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.82. ExternalHostGroups

이 서비스는 호스트 그룹을 관리합니다.

Expand
표 6.236. 메서드 요약
이름요약

list

외부 호스트 공급자에서 호스트 그룹 목록을 가져옵니다.

6.82.1. GET나열

외부 호스트 공급자에서 호스트 그룹 목록을 가져옵니다.

호스트 그룹은 호스트 공급자라고 하며 호스트 그룹에는 프로비저닝 세부 정보가 포함됩니다. 이 API는 외부 공급자가 노출하는 가능한 모든 호스트 그룹을 반환합니다.

예를 들어 모든 호스트 그룹( 123 )의 세부 정보를 얻으려면 다음과 같은 요청을 보냅니다.

GET /ovirt-engine/api/externalhostproviders/123/hostgroups

응답은 다음과 같습니다.

<external_host_groups>
  <external_host_group href="/ovirt-engine/api/externalhostproviders/123/hostgroups/234" id="234">
    <name>rhel7</name>
    <architecture_name>x86_64</architecture_name>
    <domain_name>example.com</domain_name>
    <operating_system_name>RedHat 7.3</operating_system_name>
    <subnet_name>sat0</subnet_name>
    <external_host_provider href="/ovirt-engine/api/externalhostproviders/123" id="123"/>
  </external_host_group>
  ...
</external_host_groups>

반환된 호스트 그룹 목록의 순서는 보장되지 않습니다.

Expand
표 6.237. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

groups

ExternalHostGroup[]

Out

외부 호스트 공급자에 사용 가능한 모든 호스트 그룹 목록

max

정수

in

반환할 최대 그룹 수를 설정합니다.

6.82.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.82.1.2. max

반환할 최대 그룹 수를 설정합니다. 지정하지 않으면 모든 그룹이 반환됩니다.

6.83. ExternalHostProvider

Foreman 또는 Satellite와 같은 외부 호스트 공급자를 나타냅니다.

자세한 내용은 Descheduler 설명서를 참조하십시오. 자세한 내용은 Satellite 설명서를 참조하십시오.

Expand
표 6.238. 메서드 요약
이름요약

get

외부 호스트 공급자 정보 가져오기

ovirt에서 호스트 공급자인 Foreman 또는 Satellite를 외부 공급자로 설정할 수 있습니다.

importcertificates

외부 호스트 공급자의 SSL 인증서를 가져옵니다.

제거

 

testconnectivity

외부 공급자에 대한 연결을 테스트하려면 123이 공급자의 ID인 다음 요청을 실행해야 합니다.

update

시스템에서 지정된 외부 호스트 공급자를 업데이트합니다.

6.83.1. GET가져오기

외부 호스트 공급자 정보 가져오기

ovirt에서 호스트 공급자인 Foreman 또는 Satellite를 외부 공급자로 설정할 수 있습니다. ovirt에 연결된 특정 호스트 공급자에 대한 세부 정보를 보려면 이 API를 사용합니다.

예를 들어 호스트 공급자( 123 )의 세부 정보를 얻으려면 다음과 같은 요청을 보냅니다.

GET /ovirt-engine/api/externalhostproviders/123

응답은 다음과 같습니다.

<external_host_provider href="/ovirt-engine/api/externalhostproviders/123" id="123">
  <name>mysatellite</name>
  <requires_authentication>true</requires_authentication>
  <url>https://mysatellite.example.com</url>
  <username>admin</username>
</external_host_provider>
Expand
표 6.239. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

provider

ExternalHostProvider

Out

 
6.83.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.83.2. importcertificates POST

외부 호스트 공급자의 SSL 인증서를 가져옵니다.

Expand
표 6.240. 매개변수 요약
이름유형방향요약

인증서

인증서 []

in

 

6.83.3. DELETE제거

Expand
표 6.241. 매개변수 요약
이름유형방향요약

async

부울

in

제거가 비동기적으로 수행되어야 하는지 여부를 나타냅니다.

6.83.4. testconnectivity POST

외부 공급자에 대한 연결을 테스트하려면 123이 공급자의 ID인 다음 요청을 실행해야 합니다.

POST /ovirt-engine/api/externalhostproviders/123/testconnectivity
Expand
표 6.242. 매개변수 요약
이름유형방향요약

async

부울

in

테스트를 비동기적으로 수행해야 하는지 여부를 나타냅니다.Indicates if the test should be performed asynchronously.

6.83.5. PUT업데이트

시스템에서 지정된 외부 호스트 공급자를 업데이트합니다.

Expand
표 6.243. 매개변수 요약
이름유형방향요약

async

부울

in

업데이트를 비동기적으로 수행해야 하는지 여부를 나타냅니다.

provider

ExternalHostProvider

in/Out

 

6.84. ExternalHostProviders

Expand
표 6.244. 메서드 요약
이름요약

add

새 외부 호스트 공급자를 시스템에 추가합니다.

list

외부 호스트 공급자 목록을 반환합니다.

6.84.1. POST추가

새 외부 호스트 공급자를 시스템에 추가합니다.

Expand
표 6.245. 매개변수 요약
이름유형방향요약

provider

ExternalHostProvider

in/Out

 

6.84.2. GET나열

외부 호스트 공급자 목록을 반환합니다.

반환된 호스트 공급자 목록의 순서는 보장되지 않습니다.

Expand
표 6.246. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 최대 공급자 수를 설정합니다.

providers

ExternalHostProvider[]

Out

 

search

문자열

in

반환된 외부 호스트 공급자를 제한하는 데 사용되는 쿼리 문자열입니다.

6.84.2.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.84.2.2. max

반환할 최대 공급자 수를 설정합니다. 지정하지 않으면 모든 공급자가 반환됩니다.

6.85. ExternalHosts

Expand
표 6.247. 메서드 요약
이름요약

list

외부 호스트 목록을 반환합니다.

6.85.1. GET나열

외부 호스트 목록을 반환합니다.

반환된 호스트 목록의 순서는 보장되지 않습니다.

Expand
표 6.248. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

호스트

ExternalHost[]

Out

 

max

정수

in

반환할 최대 호스트 수를 설정합니다.

6.85.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.85.1.2. max

반환할 최대 호스트 수를 설정합니다. 지정하지 않으면 모든 호스트가 반환됩니다.

6.86. ExternalNetworkProviderConfiguration

호스트의 시스템에서 외부 네트워크 공급자를 프로비저닝하는 방법을 설명합니다.

Expand
표 6.249. 메서드 요약
이름요약

get

호스트의 외부 네트워크 공급자에 대한 정보를 반환합니다.

6.86.1. GET가져오기

호스트의 외부 네트워크 공급자에 대한 정보를 반환합니다.

Expand
표 6.250. 매개변수 요약
이름유형방향요약

configuration

ExternalNetworkProviderConfiguration

Out

 

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

6.86.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.87. ExternalNetworkProviderConfigurations

호스트의 시스템에서 프로비저닝한 모든 외부 네트워크 공급자를 나열하는 서비스입니다.

Expand
표 6.251. 메서드 요약
이름요약

list

호스트의 모든 외부 네트워크 공급자 목록을 반환합니다.

6.87.1. GET나열

호스트의 모든 외부 네트워크 공급자 목록을 반환합니다.

반환된 네트워크 목록의 순서는 보장되지 않습니다.

Expand
표 6.252. 매개변수 요약
이름유형방향요약

configurations

ExternalNetworkProviderConfiguration[]

Out

 

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

6.87.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.88. ExternalProvider

외부 공급자를 관리할 수 있는 기능을 제공합니다.

Expand
표 6.253. 메서드 요약
이름요약

importcertificates

외부 호스트 공급자의 SSL 인증서를 가져옵니다.

testconnectivity

외부 공급자에 대한 연결을 테스트하려면 123이 공급자의 ID인 다음 요청을 실행해야 합니다.

6.88.1. importcertificates POST

외부 호스트 공급자의 SSL 인증서를 가져옵니다.

Expand
표 6.254. 매개변수 요약
이름유형방향요약

인증서

인증서 []

in

 

6.88.2. testconnectivity POST

외부 공급자에 대한 연결을 테스트하려면 123이 공급자의 ID인 다음 요청을 실행해야 합니다.

POST /ovirt-engine/api/externalhostproviders/123/testconnectivity
Expand
표 6.255. 매개변수 요약
이름유형방향요약

async

부울

in

테스트를 비동기적으로 수행해야 하는지 여부를 나타냅니다.Indicates if the test should be performed asynchronously.

6.89. ExternalProviderCertificate

외부 공급자에 대한 특정 인증서를 확인하는 서비스입니다.

Expand
표 6.256. 메서드 요약
이름요약

get

특정 인증서를 가져옵니다.

6.89.1. GET가져오기

특정 인증서를 가져옵니다.

GET /ovirt-engine/api/externalhostproviders/123/certificate/0

다음은 샘플 응답입니다.

<certificate id="0">
  <organization>provider.example.com</organization>
  <subject>CN=provider.example.com</subject>
  <content>...</content>
</certificate>
Expand
표 6.257. 매개변수 요약
이름유형방향요약

certificate

certificate

Out

인증서의 세부 정보입니다.

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

6.89.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.90. ExternalProviderCertificates

외부 공급자의 인증서를 볼 수 있는 서비스입니다.

Expand
표 6.258. 메서드 요약
이름요약

list

외부 공급자가 제공하는 인증서 체인을 반환합니다.

6.90.1. GET나열

외부 공급자가 제공하는 인증서 체인을 반환합니다.

GET /ovirt-engine/api/externalhostproviders/123/certificates

다음은 샘플 응답입니다.

<certificates>
  <certificate id="789">...</certificate>
  ...
</certificates>

반환된 인증서의 순서는 항상 서명 순서로 보장됩니다. 첫 번째는 서버 자체의 인증서이고, 두 번째 인증서가 첫 번째 인증서에 서명하는 CA의 인증서 등입니다.

Expand
표 6.259. 매개변수 요약
이름유형방향요약

인증서

인증서 []

Out

인증서 세부 정보가 포함된 목록.

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 최대 인증서 수를 설정합니다.

6.90.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.90.1.2. max

반환할 최대 인증서 수를 설정합니다. 지정하지 않으면 모든 인증서가 반환됩니다.

6.91. ExternalTemplateImports

외부 템플릿을 가져올 수 있는 기능을 제공합니다. 현재 OVA만 지원합니다.

Expand
표 6.260. 메서드 요약
이름요약

add

이 작업은 외부 하이퍼바이저에서 템플릿을 가져오는 데 사용됩니다.

6.91.1. POST추가

이 작업은 외부 하이퍼바이저에서 템플릿을 가져오는 데 사용됩니다.

예를 들어 템플릿 OVA의 가져오기는 다음 요청을 사용하여 원활하게 수행할 수 있습니다.

POST /externaltemplateimports

요청 본문 유형의 ExternalTemplateImport 예를 들면 다음과 같습니다.

<external_template_import>
  <template>
    <name>my_template</name>
  </template>
  <cluster id="2b18aca2-4469-11eb-9449-482ae35a5f83" />
  <storage_domain id="8bb5ade5-e988-4000-8b93-dbfc6717fe50" />
  <url>ova:///mnt/ova/ova_template.ova</url>
  <host id="8bb5ade5-e988-4000-8b93-dbfc6717fe50" />
</external_template_import>
Expand
표 6.261. 매개변수 요약
이름유형방향요약

import

ExternalTemplateImport

in/Out

 

6.92. ExternalVmImports

외부 가상 머신을 가져올 수 있는 기능을 제공합니다.

Expand
표 6.262. 메서드 요약
이름요약

add

이 작업은 KVM, XEN 또는 VMware와 같은 외부 하이퍼바이저에서 가상 시스템을 가져오는 데 사용됩니다.

6.92.1. POST추가

이 작업은 KVM, XEN 또는 VMware와 같은 외부 하이퍼바이저에서 가상 시스템을 가져오는 데 사용됩니다.

예를 들어 다음 요청을 사용하여 VMware에서 가상 시스템을 쉽게 가져올 수 있습니다.

POST /externalvmimports

요청 본문이 ExternalVmImport 유형의 경우 다음과 같습니다.

<external_vm_import>
  <vm>
    <name>my_vm</name>
  </vm>
  <cluster id="360014051136c20574f743bdbd28177fd" />
  <storage_domain id="8bb5ade5-e988-4000-8b93-dbfc6717fe50" />
  <name>vm_name_as_is_in_vmware</name>
  <sparse>true</sparse>
  <username>vmware_user</username>
  <password>123456</password>
  <provider>VMWARE</provider>
  <url>vpx://wmware_user@vcenter-host/DataCenter/Cluster/esxi-host?no_verify=1</url>
  <drivers_iso id="virtio-win-1.6.7.iso" />
</external_vm_import>
Expand
표 6.263. 매개변수 요약
이름유형방향요약

import

ExternalVmImport

in/Out

 

6.93. FenceAgent

특정 호스트에 대한 펜스 에이전트를 관리하는 서비스입니다.

Expand
표 6.264. 메서드 요약
이름요약

get

이 펜스 에이전트의 세부 정보를 가져옵니다.

제거

특정 호스트의 펜스 에이전트를 제거합니다.

update

fencing-agent를 업데이트합니다.

6.93.1. GET가져오기

이 펜스 에이전트의 세부 정보를 가져옵니다.

GET /ovirt-engine/api/hosts/123/fenceagents/0

다음은 샘플 응답입니다.

<agent id="0">
  <type>apc</type>
  <order>1</order>
  <ip>192.168.1.101</ip>
  <user>user</user>
  <password>xxx</password>
  <port>9</port>
  <options>name1=value1, name2=value2</options>
</agent>
Expand
표 6.265. 매개변수 요약
이름유형방향요약

에이전트

에이전트

Out

펜스 에이전트 세부 정보.

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

6.93.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.93.2. DELETE제거

특정 호스트의 펜스 에이전트를 제거합니다.

DELETE /ovirt-engine/api/hosts/123/fenceagents/0
Expand
표 6.266. 매개변수 요약
이름유형방향요약

async

부울

in

제거가 비동기적으로 수행되어야 하는지 여부를 나타냅니다.

6.93.3. PUT업데이트

fencing-agent를 업데이트합니다.

Expand
표 6.267. 매개변수 요약
이름유형방향요약

에이전트

에이전트

in/Out

펜스 에이전트 세부 정보.

async

부울

in

업데이트를 비동기적으로 수행해야 하는지 여부를 나타냅니다.

6.94. FenceAgents

특정 호스트의 펜스 에이전트를 관리하는 서비스입니다.

Expand
표 6.268. 메서드 요약
이름요약

add

호스트에 새 fencing-agent를 추가합니다.

list

호스트에 구성된 펜싱 에이전트 목록을 반환합니다.

6.94.1. POST추가

호스트에 새 fencing-agent를 추가합니다.

POST /ovirt-engine/api/hosts/123/fenceagents

You should consult the /usr/sbin/fence_<agent_name> manual page for
the legal parameters to [name1=value1, name2=value2,...] in the options field.
If any parameter in options appears by name that means that it is mandatory.
For example in <options>slot=7[,name1=value1, name2=value2,...]</options>
slot is mandatory.

APC, Bladecenter, wti 펜싱 에이전트/s 샘플 요청:

  <agent>
    <type>apc</type>
    <order>1</order>
    <ip>192.168.1.101</ip>
    <user>user</user>
    <password>xxx</password>
    <port>9</port>
    <options>slot=7[,name1=value1, name2=value2,...]</options>
  </agent>

apc_snmp, hpblade, ilo, ilo2, ilo_ssh, redfish, rsa 펜싱 에이전트/s 샘플 요청:

  <agent>
    <type>apc_snmp</type>
    <order>1</order>
    <ip>192.168.1.101</ip>
    <user>user</user>
    <password>xxx</password>
    <port>9</port>
    <options>[name1=value1, name2=value2,...]</options>
  </agent>

cisco_ucs, drac5, eps 펜싱 에이전트/s 샘플 요청:

  <agent>
    <type>cisco_ucs</type>
    <order>1</order>
    <ip>192.168.1.101</ip>
    <user>user</user>
    <password>xxx</password>
    <options>slot=7[,name1=value1, name2=value2,...]</options>
  </agent>

drac7, ilo3, ilo4, ipmilan, rsb 펜싱 에이전트/s 샘플 요청:

  <agent>
    <type>drac7</type>
    <order>1</order>
    <ip>192.168.1.101</ip>
    <user>user</user>
    <password>xxx</password>
    <options>[name1=value1, name2=value2,...]</options>
  </agent>
Expand
표 6.269. 매개변수 요약
이름유형방향요약

에이전트

에이전트

in/Out

 

6.94.2. GET나열

호스트에 구성된 펜싱 에이전트 목록을 반환합니다.

GET /ovirt-engine/api/hosts/123/fenceagents

다음은 샘플 응답입니다.

<agents>
  <agent id="0">
    <type>apc</type>
    <order>1</order>
    <ip>192.168.1.101</ip>
    <user>user</user>
    <password>xxx</password>
    <port>9</port>
    <options>name1=value1, name2=value2</options>
  </agent>
</agents>

반환된 펜싱 에이전트 목록의 순서는 보장되지 않습니다.

Expand
표 6.270. 매개변수 요약
이름유형방향요약

에이전트

Agent[]

Out

펜스 에이전트 세부 정보 목록.

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 최대 에이전트 수를 설정합니다.

6.94.2.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.94.2.2. max

반환할 최대 에이전트 수를 설정합니다. 지정하지 않으면 모든 에이전트가 반환됩니다.

6.95. 파일

Expand
표 6.271. 메서드 요약
이름요약

get

 

6.95.1. GET가져오기

Expand
표 6.272. 매개변수 요약
이름유형방향요약

file

파일

Out

 

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

6.95.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.96. 파일

클라이언트가 사용 가능한 파일을 나열하는 방법을 제공합니다.

이 서비스는 특별히 관리자가 업로드하는 ISO 이미지 및 VFD(가상 플로피 디스크)를 포함하는 ISO 스토리지 도메인을 대상으로 합니다.

CD-ROM 장치를 가상 시스템에 추가하려면 ISO 스토리지 도메인 파일의 ISO 이미지가 필요합니다.

Expand
표 6.273. 메서드 요약
이름요약

list

스토리지 도메인에서 사용 가능한 ISO 이미지 및 가상 플로피 디스크 목록을 반환합니다.

6.96.1. GET나열

스토리지 도메인에서 사용 가능한 ISO 이미지 및 가상 플로피 디스크 목록을 반환합니다. 반환된 목록의 순서가 보장되지 않습니다.

refresh 매개변수가 false 인 경우 반환된 목록에는 스토리지 도메인에 대한 최근 변경 사항이 반영되지 않을 수 있습니다. 예를 들어 최근에 추가된 새 ISO 파일이 포함되어 있지 않을 수 있습니다. 이는 서버가 성능 향상을 위해 파일 목록을 캐시하기 때문입니다. 최신 결과를 얻으려면 refresh 매개 변수를 true 로 설정합니다.

refresh 매개변수의 기본값은 true 이지만 설정 값 ForceRefreshDomainFilesByDefault 를 사용하여 변경할 수 있습니다.

# engine-config -s ForceRefreshDomainFilesByDefault=false
중요

refresh 매개변수의 값을 true 로 설정하면 서버의 성능에 영향을 미칩니다. 필요한 경우에만 사용하십시오.

Expand
표 6.274. 매개변수 요약
이름유형방향요약

case_sensitive

부울

in

search 매개변수를 사용하여 수행된 검색에 대소문자를 고려해야 하는지 여부를 나타냅니다.

file

파일 []

Out

 

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 최대 파일 수를 설정합니다.

새로 고침

부울

in

특정 간격으로 업데이트된 캐시된 결과를 표시하지 않고 스토리지 도메인에서 파일 목록을 새로 고쳐야 하는지 여부를 나타냅니다.

search

문자열

in

반환된 파일을 제한하는 데 사용되는 쿼리 문자열입니다.

6.96.1.1. case_sensitive

search 매개변수를 사용하여 수행된 검색에 대소문자를 고려해야 하는지 여부를 나타냅니다. 기본값은 true입니다.

6.96.1.2. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.96.1.3. max

반환할 최대 파일 수를 설정합니다. 지정하지 않으면 모든 파일이 반환됩니다.

6.97. filter

Expand
표 6.275. 메서드 요약
이름요약

get

 

제거

 

6.97.1. GET가져오기

Expand
표 6.276. 매개변수 요약
이름유형방향요약

filter

부울

in

사용자의 권한에 따라 결과를 필터링해야 하는지 여부를 나타냅니다.

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

결과

filter

Out

 
6.97.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.97.2. DELETE제거

Expand
표 6.277. 매개변수 요약
이름유형방향요약

async

부울

in

제거가 비동기적으로 수행되어야 하는지 여부를 나타냅니다.

6.98. 필터

스케줄링 정책에서 사용하는 필터를 관리합니다.

Expand
표 6.278. 메서드 요약
이름요약

add

지정된 사용자 정의 스케줄링 정책에 필터를 추가합니다.

list

스케줄링 정책에서 사용하는 필터 목록을 반환합니다.

6.98.1. POST추가

지정된 사용자 정의 스케줄링 정책에 필터를 추가합니다.

Expand
표 6.279. 매개변수 요약
이름유형방향요약

filter

filter

in/Out

 

6.98.2. GET나열

스케줄링 정책에서 사용하는 필터 목록을 반환합니다.

반환된 필터 목록의 순서는 보장되지 않습니다.

Expand
표 6.280. 매개변수 요약
이름유형방향요약

filter

부울

in

사용자의 권한에 따라 결과를 필터링해야 하는지 여부를 나타냅니다.

필터

필터 []

Out

 

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 최대 필터 수를 설정합니다.

6.98.2.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.98.2.2. max

반환할 최대 필터 수를 설정합니다. 지정하지 않으면 모든 필터가 반환됩니다.

6.99. 팔로우

6.100. GlusterBrick

이 서비스는 단일 gluster brick을 관리합니다.

Expand
표 6.281. 메서드 요약
이름요약

get

brick에 대한 세부 정보를 가져옵니다.

제거

brick을 제거합니다.

replace

이 brick을 새 brick으로 교체합니다.

6.100.1. GET가져오기

brick에 대한 세부 정보를 가져옵니다.

All-Content 헤더가 true 로 설정된 기본 gluster 볼륨에서 brick의 상태 세부 정보를 검색합니다. 이는 실행 중인 gluster 볼륨 상태 <volumename> <brickname> 세부 사항과 동일합니다.

예를 들어 gluster 볼륨 123 의 brick 234 에 대한 세부 정보를 얻으려면 다음과 같은 요청을 보냅니다.

GET /ovirt-engine/api/clusters/567/glustervolumes/123/glusterbricks/234

다음과 같은 응답 본문을 반환합니다.Returns a response body like this:

<brick id="234">
  <name>host1:/rhgs/data/brick1</name>
  <brick_dir>/rhgs/data/brick1</brick_dir>
  <server_id>111</server_id>
  <status>up</status>
  <device>/dev/mapper/RHGS_vg1-lv_vmaddldisks</device>
  <fs_name>xfs</fs_name>
  <gluster_clients>
    <gluster_client>
      <bytes_read>2818417648</bytes_read>
      <bytes_written>1384694844</bytes_written>
      <client_port>1011</client_port>
      <host_name>client2</host_name>
    </gluster_client>
  </gluster_clients>
  <memory_pools>
    <memory_pool>
      <name>data-server:fd_t</name>
      <alloc_count>1626348</alloc_count>
      <cold_count>1020</cold_count>
      <hot_count>4</hot_count>
      <max_alloc>23</max_alloc>
      <max_stdalloc>0</max_stdalloc>
      <padded_size>140</padded_size>
      <pool_misses>0</pool_misses>
    </memory_pool>
  </memory_pools>
  <mnt_options>rw,seclabel,noatime,nodiratime,attr2,inode64,sunit=512,swidth=2048,noquota</mnt_options>
  <pid>25589</pid>
  <port>49155</port>
</brick>
Expand
표 6.282. 매개변수 요약
이름유형방향요약

brick

GlusterBrick

Out

 

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

6.100.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.100.2. DELETE제거

brick을 제거합니다.

기본 gluster 볼륨에서 brick을 제거하고 데이터베이스에서 항목을 삭제합니다. 데이터 마이그레이션 없이 단일 brick을 제거할 때만 사용할 수 있습니다. 여러 개의 brick과 데이터 마이그레이션을 제거하려면 대신 migrate 를 사용합니다.

예를 들어 gluster 볼륨 123 에서 brick 234 를 삭제하려면 다음과 같은 요청을 보냅니다.

DELETE /ovirt-engine/api/clusters/567/glustervolumes/123/glusterbricks/234
Expand
표 6.283. 매개변수 요약
이름유형방향요약

async

부울

in

제거가 비동기적으로 수행되어야 하는지 여부를 나타냅니다.

6.100.3. POST교체

이 brick을 새 brick으로 교체합니다.

중요

이 작업은 엔진 버전 3.5 이후 더 이상 사용되지 않으며 나중에 제거됩니다. add brick(s) 을 사용하고 대신 brick을 마이그레이션 합니다.

Expand
표 6.284. 매개변수 요약
이름유형방향요약

async

부울

in

교체를 비동기적으로 수행해야 하는지 여부를 나타냅니다.Indicates if the replacement should be performed asynchronously.

force

부울

in

 

6.101. GlusterBricks

이 서비스는 gluster 볼륨에서 gluster 브릭을 관리합니다.

Expand
표 6.285. 메서드 요약
이름요약

activate

brick 제거 작업의 brick 게시 데이터 마이그레이션을 활성화합니다.

add

gluster 볼륨에 brick 목록을 추가합니다.

list

gluster 볼륨의 brick을 나열합니다.

migrate

brick을 제거하기 전에 데이터 마이그레이션을 시작합니다.

제거

gluster 볼륨에서 brick을 제거합니다.

stopmigrate

remove brick 작업의 brick에서 데이터 마이그레이션을 중지합니다.

6.101.1. POST활성화

brick 제거 작업의 brick 게시 데이터 마이그레이션을 활성화합니다.

brick에서 데이터 마이그레이션이 완료되면 brick을 활성화하는 데 사용되지만 사용자는 더 이상 brick을 제거하지 않습니다. 이전에 제거용으로 표시된 brick이 이제 일반 brick으로 사용됩니다.

예를 들어 데이터가 마이그레이션된 glustervolume 123 의 brick을 유지하려면 다음과 같은 요청을 보냅니다.

POST /ovirt-engine/api/clusters/567/glustervolumes/123/glusterbricks/activate

다음과 같이 요청 본문이 있는 경우:

<action>
  <bricks>
    <brick>
      <name>host1:/rhgs/brick1</name>
    </brick>
  </bricks>
</action>
Expand
표 6.286. 매개변수 요약
이름유형방향요약

async

부울

in

활성화를 비동기적으로 수행해야 하는지 여부를 나타냅니다.

brick

GlusterBrick[]

in

다시 활성화해야 하는 brick 목록입니다.

6.101.2. POST추가

gluster 볼륨에 brick 목록을 추가합니다.

brick을 추가하여 gluster 볼륨을 확장하는 데 사용됩니다. 복제 볼륨 유형의 경우 replica_count 매개 변수를 전달해야 합니다. 복제본 수가 증가하면 복제본 세트 수와 동일한 brick 수가 있어야 합니다.

예를 들어 gluster 볼륨 123 에 brick을 추가하려면 다음과 같은 요청을 보냅니다.

POST /ovirt-engine/api/clusters/567/glustervolumes/123/glusterbricks

다음과 같이 요청 본문이 있는 경우:

<bricks>
  <brick>
    <server_id>111</server_id>
    <brick_dir>/export/data/brick3</brick_dir>
  </brick>
</bricks>
Expand
표 6.287. 매개변수 요약
이름유형방향요약

brick

GlusterBrick[]

in/Out

볼륨에 추가할 brick 목록

replica_count

정수

in

볼륨 사후 추가 작업의 복제본 수입니다.

stripe_count

정수

in

볼륨 후 추가 작업의 스트라이프 수입니다.

6.101.3. GET나열

gluster 볼륨의 brick을 나열합니다.

예를 들어 gluster 볼륨 123 의 brick을 나열하려면 다음과 같은 요청을 보냅니다.

GET /ovirt-engine/api/clusters/567/glustervolumes/123/glusterbricks

다음과 같이 출력을 제공합니다.

<bricks>
  <brick id="234">
    <name>host1:/rhgs/data/brick1</name>
    <brick_dir>/rhgs/data/brick1</brick_dir>
    <server_id>111</server_id>
    <status>up</status>
  </brick>
  <brick id="233">
    <name>host2:/rhgs/data/brick1</name>
    <brick_dir>/rhgs/data/brick1</brick_dir>
    <server_id>222</server_id>
    <status>up</status>
  </brick>
</bricks>

반환된 목록의 순서는 gluster 볼륨 생성 시 제공된 brick 순서를 기반으로 합니다.

Expand
표 6.288. 매개변수 요약
이름유형방향요약

brick

GlusterBrick[]

Out

 

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 최대 brick 수를 설정합니다.

6.101.3.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.101.3.2. max

반환할 최대 brick 수를 설정합니다. 지정하지 않으면 모든 brick이 반환됩니다.

6.101.4. migrate POST

brick을 제거하기 전에 데이터 마이그레이션을 시작합니다.

brick 제거는 제거할 brick의 데이터가 먼저 나머지 brick으로 마이그레이션되는 2단계 프로세스입니다. 마이그레이션이 완료되면 API 제거를 통해 brick 제거를 확인합니다. 언제든지 작업을 취소하려면 중지 마이그레이션 을 호출해야 합니다.

예를 들어 ID 123 이 있는 gluster 볼륨에서 brick을 삭제하려면 요청을 보냅니다.

POST /ovirt-engine/api/clusters/567/glustervolumes/123/glusterbricks/migrate

다음과 같이 요청 본문이 있는 경우:

<action>
  <bricks>
    <brick>
      <name>host1:/rhgs/brick1</name>
    </brick>
  </bricks>
</action>

마이그레이션 프로세스는 작업 및 단계를 사용하여 API에서 반환된 작업 ID에서 추적할 수 있습니다. ???

Expand
표 6.289. 매개변수 요약
이름유형방향요약

async

부울

in

마이그레이션을 비동기적으로 수행해야 하는지 여부를 나타냅니다.

brick

GlusterBrick[]

in

데이터 마이그레이션을 시작해야 하는 brick 목록입니다.

6.101.5. DELETE제거

gluster 볼륨에서 brick을 제거합니다.

데이터 손실 없이 brick을 제거하는 권장 방법은 stopmigrate 를 사용하여 데이터를 먼저 마이그레이션한 다음 제거하는 것입니다. 제거하기 전에 브래킷에서 마이그레이션을 호출하지 않으면 데이터 마이그레이션 없이 brick이 제거되고 이로 인해 데이터가 손실될 수 있습니다.

예를 들어 gluster 볼륨 123 에서 브릭을 삭제하려면 다음과 같은 요청을 보냅니다.

DELETE /ovirt-engine/api/clusters/567/glustervolumes/123/glusterbricks

다음과 같이 요청 본문이 있는 경우:

<bricks>
  <brick>
    <name>host:brick_directory</name>
  </brick>
</bricks>
Expand
표 6.290. 매개변수 요약
이름유형방향요약

async

부울

in

제거가 비동기적으로 수행되어야 하는지 여부를 나타냅니다.

brick

GlusterBrick[]

in

제거할 brick 목록입니다.

replica_count

정수

in

볼륨 사후 추가 작업의 복제본 수입니다.

6.101.6. 마이그레이션 POST중지

remove brick 작업의 brick에서 데이터 마이그레이션을 중지합니다.

사용자가 brick을 계속 사용하려는 경우 2단계 제거 brick 프로세스의 일부로 시작된 데이터 마이그레이션을 취소하려면 다음을 수행합니다. 제거용으로 표시된 brick은 이 작업을 게시한 후 일반 brick으로 작동합니다.

예를 들어 gluster 볼륨 123 의 brick에서 데이터 마이그레이션을 중지하려면 다음과 같은 요청을 보냅니다.

POST /ovirt-engine/api/clusters/567/glustervolumes/123/glusterbricks/stopmigrate

다음과 같이 요청 본문이 있는 경우:

<bricks>
  <brick>
    <name>host:brick_directory</name>
  </brick>
</bricks>
Expand
표 6.291. 매개변수 요약
이름유형방향요약

async

부울

in

비동기적으로 작업을 수행해야 하는지 여부를 나타냅니다.Indicates whether the action should be performed asynchronously.

brick

GlusterBrick[]

in

데이터 마이그레이션을 중지해야 하는 brick 목록입니다.

6.101.6.1. brick

데이터 마이그레이션을 중지해야 하는 brick 목록입니다. 이 목록은 마이그레이션 하려면 전달된 인수와 일치해야 합니다.

6.102. GlusterHook

Expand
표 6.292. 메서드 요약
이름요약

disable

클러스터의 모든 서버에서 Gluster 후크를 비활성화하여 클러스터의 서버 간 후크 상태 충돌을 해결합니다.

enable

클러스터의 모든 서버에서 Gluster 후크를 비활성화하여 클러스터의 서버 간 후크 상태 충돌을 해결합니다.

get

 

제거

이 Gluster 후크를 클러스터의 모든 서버에서 제거하고 데이터베이스에서 삭제합니다.

resolve

해결 유형에 따라 누락된 후크 충돌을 해결합니다.

6.102.1. POST비활성화

클러스터의 모든 서버에서 Gluster 후크를 비활성화하여 클러스터의 서버 간 후크 상태 충돌을 해결합니다. 이렇게 하면 데이터베이스의 후크 상태가 DISABLED 로 업데이트됩니다.

Expand
표 6.293. 매개변수 요약
이름유형방향요약

async

부울

in

비동기적으로 작업을 수행해야 하는지 여부를 나타냅니다.Indicates whether the action should be performed asynchronously.

6.102.2. POST활성화

클러스터의 모든 서버에서 Gluster 후크를 비활성화하여 클러스터의 서버 간 후크 상태 충돌을 해결합니다. 이렇게 하면 데이터베이스의 후크 상태가 DISABLED 로 업데이트됩니다.

Expand
표 6.294. 매개변수 요약
이름유형방향요약

async

부울

in

비동기적으로 작업을 수행해야 하는지 여부를 나타냅니다.Indicates whether the action should be performed asynchronously.

6.102.3. GET가져오기

Expand
표 6.295. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

후크

GlusterHook

Out

 
6.102.3.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.102.4. DELETE제거

이 Gluster 후크를 클러스터의 모든 서버에서 제거하고 데이터베이스에서 삭제합니다.

Expand
표 6.296. 매개변수 요약
이름유형방향요약

async

부울

in

제거가 비동기적으로 수행되어야 하는지 여부를 나타냅니다.

6.102.5. POST확인

해결 유형에 따라 누락된 후크 충돌을 해결합니다.

ADD 의 경우 engine 데이터베이스에 저장된 후크를 후크가 누락된 모든 서버에 복사하여 해결할 수 있습니다. 엔진은 후크가 누락된 모든 서버 목록을 유지 관리합니다.

COPY 의 경우 engine 데이터베이스에 저장된 후크를 후크가 누락된 모든 서버에 복사하여 후크 콘텐츠의 충돌을 해결합니다. 엔진은 콘텐츠가 충돌하는 모든 서버 목록을 유지 관리합니다. 호스트 ID가 매개 변수로 전달되면 서버의 후크 콘텐츠가 마스터로 사용되어 클러스터의 다른 서버에 복사합니다.

Expand
표 6.297. 매개변수 요약
이름유형방향요약

async

부울

in

비동기적으로 작업을 수행해야 하는지 여부를 나타냅니다.Indicates whether the action should be performed asynchronously.

host

호스트

in

 

resolution_type

문자열

in

 

6.103. GlusterHooks

Expand
표 6.298. 메서드 요약
이름요약

list

후크 목록을 반환합니다.

6.103.1. GET나열

후크 목록을 반환합니다.

반환된 후크 목록의 순서는 보장되지 않습니다.

Expand
표 6.299. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

후크

GlusterHook[]

Out

 

max

정수

in

반환할 최대 후크 수를 설정합니다.

6.103.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.103.1.2. max

반환할 최대 후크 수를 설정합니다. 지정하지 않으면 모든 후크가 반환됩니다.

6.104. GlusterVolume

이 서비스는 단일 gluster 볼륨을 관리합니다.

Expand
표 6.300. 메서드 요약
이름요약

get

gluster 볼륨 세부 정보를 가져옵니다.

getprofilestatistics

gluster 볼륨 프로파일 통계를 가져옵니다.

rebalance

gluster 볼륨을 리밸런스합니다.

제거

gluster 볼륨을 제거합니다.

resetalloptions

gluster 볼륨에 설정된 모든 옵션을 재설정합니다.

resetoption

gluster 볼륨에서 특정 옵션을 재설정합니다.

setoption

gluster 볼륨에 특정 옵션을 설정합니다.

start

gluster 볼륨을 시작합니다.

startprofile

gluster 볼륨 프로파일링을 시작합니다.

중지

gluster 볼륨을 중지합니다.

stopprofile

gluster 볼륨 프로파일링을 중지합니다.

stoprebalance

gluster 볼륨 리밸런싱을 중지합니다.

6.104.1. GET가져오기

gluster 볼륨 세부 정보를 가져옵니다.

예를 들어 클러스터 456 에서 식별자 123 가 있는 gluster 볼륨의 세부 정보를 얻으려면 다음과 같은 요청을 보냅니다.

GET /ovirt-engine/api/clusters/456/glustervolumes/123

이 GET 요청은 다음 출력을 반환합니다.

<gluster_volume id="123">
 <name>data</name>
 <link href="/ovirt-engine/api/clusters/456/glustervolumes/123/glusterbricks" rel="glusterbricks"/>
 <disperse_count>0</disperse_count>
 <options>
   <option>
     <name>storage.owner-gid</name>
     <value>36</value>
   </option>
   <option>
     <name>performance.io-cache</name>
     <value>off</value>
   </option>
   <option>
     <name>cluster.data-self-heal-algorithm</name>
     <value>full</value>
   </option>
 </options>
 <redundancy_count>0</redundancy_count>
 <replica_count>3</replica_count>
 <status>up</status>
 <stripe_count>0</stripe_count>
 <transport_types>
   <transport_type>tcp</transport_type>
 </transport_types>
 <volume_type>replicate</volume_type>
 </gluster_volume>
Expand
표 6.301. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

volume

GlusterVolume

Out

gluster 볼륨 표현입니다.

6.104.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.104.2. getprofilestatistics POST

gluster 볼륨 프로파일 통계를 가져옵니다.

예를 들어 클러스터 456 에서 식별자가 123 인 gluster 볼륨에 대한 프로필 통계를 얻으려면 다음과 같은 요청을 보냅니다.

POST /ovirt-engine/api/clusters/456/glustervolumes/123/getprofilestatistics
Expand
표 6.302. 매개변수 요약
이름유형방향요약

세부 정보

GlusterVolumeProfileDetails

Out

작업에서 반환된 Gluster 볼륨 프로파일링 정보.

6.104.3. 리밸런스 POST

gluster 볼륨을 리밸런스합니다.

gluster 볼륨을 리밸런싱하면 모든 brick에 데이터를 균등하게 분산하는 데 도움이 됩니다. gluster 볼륨을 확장하거나 축소한 후(데이터 마이그레이션 없이) brick에 데이터를 리밸런싱해야 합니다. 복제되지 않은 볼륨에서 리밸런스 작업을 수행하려면 모든 brick이 온라인 상태여야 합니다. 복제 볼륨에서 하나 이상의 복제본은 온라인 상태여야 합니다.

예를 들어 클러스터 456 에서 식별자가 123 인 gluster 볼륨을 리밸런스하려면 다음과 같은 요청을 보냅니다.

POST /ovirt-engine/api/clusters/456/glustervolumes/123/rebalance
Expand
표 6.303. 매개변수 요약
이름유형방향요약

async

부울

in

리밸런스가 비동기적으로 수행되어야 하는지 여부를 나타냅니다.Indicates if the rebalance should be performed asynchronously.

fix_layout

부울

in

true로 설정하면 리밸런스가 레이아웃을 수정하여 볼륨에 추가된 새 데이터가 모든 호스트에 분산되도록 합니다.

force

부울

in

리밸런스가 강제로 시작되었는지를 나타냅니다.

6.104.3.1. fix_layout

true로 설정하면 리밸런스가 레이아웃을 수정하여 볼륨에 추가된 새 데이터가 모든 호스트에 분산되도록 합니다. 그러나 기존 데이터를 마이그레이션/재밸런스하지 않습니다. 기본값은 false 입니다.

6.104.3.2. force

리밸런스가 강제로 시작되었는지를 나타냅니다. 이전 클라이언트가 클러스터에 연결된 경우에도 rebalance 명령을 force 옵션으로 실행할 수 있습니다. 그러나 이로 인해 데이터 손실 상황이 발생할 수 있습니다. 기본값은 false 입니다.

6.104.4. DELETE제거

gluster 볼륨을 제거합니다.

예를 들어 클러스터 456 에서 식별자가 123 인 볼륨을 제거하려면 다음과 같은 요청을 보냅니다.

DELETE /ovirt-engine/api/clusters/456/glustervolumes/123
Expand
표 6.304. 매개변수 요약
이름유형방향요약

async

부울

in

제거가 비동기적으로 수행되어야 하는지 여부를 나타냅니다.

6.104.5. resetalloptions POST

gluster 볼륨에 설정된 모든 옵션을 재설정합니다.

예를 들어 클러스터 456 에서 식별자 123 가 있는 gluster 볼륨의 모든 옵션을 재설정하려면 다음과 같은 요청을 보냅니다.

POST /ovirt-engine/api/clusters/456/glustervolumes/123/resetalloptions
Expand
표 6.305. 매개변수 요약
이름유형방향요약

async

부울

in

재설정이 비동기적으로 수행되어야 하는지 여부를 나타냅니다.

6.104.6. resetoption POST

gluster 볼륨에서 특정 옵션을 재설정합니다.

예를 들어 클러스터 456 에서 식별자가 123 인 gluster 볼륨에서 특정 옵션 option1 을 재설정하려면 다음과 같은 요청을 보냅니다.

POST /ovirt-engine/api/clusters/456/glustervolumes/123/resetoption

다음과 같은 요청 본문으로:

<action>
 <option name="option1"/>
</action>
Expand
표 6.306. 매개변수 요약
이름유형방향요약

async

부울

in

재설정이 비동기적으로 수행되어야 하는지 여부를 나타냅니다.

force

부울

in

 

옵션

옵션

in

재설정할 수 있는 옵션입니다.

6.104.7. setoption POST

gluster 볼륨에 특정 옵션을 설정합니다.

예를 들어 클러스터 456 에 식별자가 123 인 gluster 볼륨에서 value1 값이 value1인 option1 을 설정하려면 다음과 같은 요청을 보냅니다.

POST /ovirt-engine/api/clusters/456/glustervolumes/123/setoption

다음과 같은 요청 본문으로:

<action>
 <option name="option1" value="value1"/>
</action>
Expand
표 6.307. 매개변수 요약
이름유형방향요약

async

부울

in

비동기적으로 작업을 수행해야 하는지 여부를 나타냅니다.Indicates whether the action should be performed asynchronously.

옵션

옵션

in

설정할 옵션입니다.

6.104.8. POST시작

gluster 볼륨을 시작합니다.

Gluster Volume은 데이터를 읽기/쓰기로 시작해야 합니다. 예를 들어 클러스터 456 에서 식별자가 123 인 gluster 볼륨을 시작하려면 다음과 같은 요청을 보냅니다.

POST /ovirt-engine/api/clusters/456/glustervolumes/123/start
Expand
표 6.308. 매개변수 요약
이름유형방향요약

async

부울

in

비동기적으로 작업을 수행해야 하는지 여부를 나타냅니다.Indicates whether the action should be performed asynchronously.

force

부울

in

볼륨을 강제로 시작해야 하는지 여부를 나타냅니다.

6.104.8.1. force

볼륨을 강제로 시작해야 하는지 여부를 나타냅니다. gluster 볼륨이 이미 시작되지만 몇/all의 brick이 다운되면 force start를 사용하여 모든 brick을 가져올 수 있습니다. 기본값은 false 입니다.

6.104.9. startprofile POST

gluster 볼륨 프로파일링을 시작합니다.

예를 들어 클러스터 456 에서 식별자 123 가 있는 gluster 볼륨 프로파일링을 시작하려면 다음과 같은 요청을 보냅니다.

POST /ovirt-engine/api/clusters/456/glustervolumes/123/startprofile
Expand
표 6.309. 매개변수 요약
이름유형방향요약

async

부울

in

비동기적으로 작업을 수행해야 하는지 여부를 나타냅니다.Indicates whether the action should be performed asynchronously.

6.104.10. POST중지

gluster 볼륨을 중지합니다.

볼륨을 중지하면 데이터에 액세스할 수 없게 됩니다.

예를 들어 클러스터 456 에서 식별자가 123 인 gluster 볼륨을 중지하려면 다음과 같은 요청을 보냅니다.

POST /ovirt-engine/api/clusters/456/glustervolumes/123/stop
Expand
표 6.310. 매개변수 요약
이름유형방향요약

async

부울

in

비동기적으로 작업을 수행해야 하는지 여부를 나타냅니다.Indicates whether the action should be performed asynchronously.

force

부울

in

 

6.104.11. stopprofile POST

gluster 볼륨 프로파일링을 중지합니다.

예를 들어 클러스터 456 에서 식별자가 123 인 gluster 볼륨 프로파일링을 중지하려면 다음과 같은 요청을 보냅니다.

POST /ovirt-engine/api/clusters/456/glustervolumes/123/stopprofile
Expand
표 6.311. 매개변수 요약
이름유형방향요약

async

부울

in

비동기적으로 작업을 수행해야 하는지 여부를 나타냅니다.Indicates whether the action should be performed asynchronously.

6.104.12. stoprebalance POST

gluster 볼륨 리밸런싱을 중지합니다.

예를 들어 클러스터 456 에서 식별자 123 가 있는 gluster 볼륨의 재조정을 중지하려면 다음과 같은 요청을 보냅니다.

POST /ovirt-engine/api/clusters/456/glustervolumes/123/stoprebalance
Expand
표 6.312. 매개변수 요약
이름유형방향요약

async

부울

in

비동기적으로 작업을 수행해야 하는지 여부를 나타냅니다.Indicates whether the action should be performed asynchronously.

6.105. GlusterVolumes

이 서비스는 클러스터에서 사용 가능한 gluster 볼륨 컬렉션을 관리합니다.

Expand
표 6.313. 메서드 요약
이름요약

add

새 gluster 볼륨을 생성합니다.

list

클러스터의 모든 gluster 볼륨을 나열합니다.

6.105.1. POST추가

새 gluster 볼륨을 생성합니다.

볼륨은 볼륨 매개변수의 속성을 기반으로 생성됩니다. 속성 이름,volume_typebrick 이 필요합니다.

예를 들어 이름이 myvolume 인 볼륨을 클러스터 123 에 추가하려면 다음 요청을 보냅니다.

POST /ovirt-engine/api/clusters/123/glustervolumes

다음과 같은 요청 본문으로:

<gluster_volume>
  <name>myvolume</name>
  <volume_type>replicate</volume_type>
  <replica_count>3</replica_count>
  <bricks>
    <brick>
      <server_id>server1</server_id>
      <brick_dir>/exp1</brick_dir>
    </brick>
    <brick>
      <server_id>server2</server_id>
      <brick_dir>/exp1</brick_dir>
    </brick>
    <brick>
      <server_id>server3</server_id>
      <brick_dir>/exp1</brick_dir>
    </brick>
  <bricks>
</gluster_volume>
Expand
표 6.314. 매개변수 요약
이름유형방향요약

volume

GlusterVolume

in/Out

볼륨을 생성할 gluster 볼륨 정의가 입력으로 전달되고 새로 생성된 볼륨이 반환됩니다.

6.105.2. GET나열

클러스터의 모든 gluster 볼륨을 나열합니다.

예를 들어 클러스터 456 의 모든 Gluster 볼륨을 나열하려면 다음과 같은 요청을 보냅니다.

GET /ovirt-engine/api/clusters/456/glustervolumes

반환된 볼륨 목록의 순서는 보장되지 않습니다.

Expand
표 6.315. 매개변수 요약
이름유형방향요약

case_sensitive

부울

in

검색 매개 변수를 사용하여 수행된 검색이 대소문자를 고려하여 수행해야 하는지 여부를 나타냅니다.

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 최대 볼륨 수를 설정합니다.

search

문자열

in

반환된 볼륨을 제한하는 데 사용되는 쿼리 문자열입니다.

volumes

GlusterVolume[]

Out

 
6.105.2.1. case_sensitive

검색 매개 변수를 사용하여 수행된 검색이 대소문자를 고려하여 수행해야 하는지 여부를 나타냅니다. 기본값은 true 입니다. 즉, 해당 케이스가 고려됩니다. 대소문자를 무시하고자 하는 경우 false 로 설정합니다.

6.105.2.2. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.105.2.3. max

반환할 최대 볼륨 수를 설정합니다. 지정하지 않으면 모든 볼륨이 반환됩니다.

6.106. 그룹

사용자 그룹을 관리합니다. 이 서비스를 사용하여 그룹 세부 정보를 가져오거나 그룹을 제거합니다. 새 그룹을 추가하려면 그룹 컬렉션을 관리하는 서비스를 사용하십시오.

Expand
표 6.316. 메서드 요약
이름요약

get

시스템 그룹 정보를 가져옵니다.

제거

시스템 그룹을 제거합니다.

6.106.1. GET가져오기

시스템 그룹 정보를 가져옵니다.

사용법:

GET /ovirt-engine/api/groups/123

은 그룹 정보를 반환합니다.

<group href="/ovirt-engine/api/groups/123" id="123">
  <name>mygroup</name>
  <link href="/ovirt-engine/api/groups/123/roles" rel="roles"/>
  <link href="/ovirt-engine/api/groups/123/permissions" rel="permissions"/>
  <link href="/ovirt-engine/api/groups/123/tags" rel="tags"/>
  <domain_entry_id>476652557A382F67696B6D2B32762B37796E46476D513D3D</domain_entry_id>
  <namespace>DC=example,DC=com</namespace>
  <domain href="/ovirt-engine/api/domains/ABCDEF" id="ABCDEF">
    <name>myextension-authz</name>
  </domain>
</group>
Expand
표 6.317. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

get

그룹

Out

시스템 그룹.

6.106.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.106.2. DELETE제거

시스템 그룹을 제거합니다.

사용법:

DELETE /ovirt-engine/api/groups/123
Expand
표 6.318. 매개변수 요약
이름유형방향요약

async

부울

in

제거가 비동기적으로 수행되어야 하는지 여부를 나타냅니다.

6.107. 그룹

사용자 그룹의 컬렉션을 관리합니다.

Expand
표 6.319. 메서드 요약
이름요약

add

디렉터리 서비스에서 그룹을 추가합니다.

list

시스템의 모든 그룹을 나열합니다.

6.107.1. POST추가

디렉터리 서비스에서 그룹을 추가합니다. 도메인 이름은 권한 부여 공급자의 이름입니다.

예를 들어 internal-authz 권한 공급자에서 Developers 그룹을 추가하려면 다음과 같은 요청을 보냅니다.

POST /ovirt-engine/api/groups

다음과 같이 요청 본문이 있는 경우:

<group>
  <name>Developers</name>
  <domain>
    <name>internal-authz</name>
  </domain>
</group>
Expand
표 6.320. 매개변수 요약
이름유형방향요약

group

그룹

in/Out

추가할 그룹입니다.

6.107.2. GET나열

시스템의 모든 그룹을 나열합니다.

사용법:

GET /ovirt-engine/api/groups

은 그룹 목록을 반환합니다.

<groups>
  <group href="/ovirt-engine/api/groups/123" id="123">
    <name>mygroup</name>
    <link href="/ovirt-engine/api/groups/123/roles" rel="roles"/>
    <link href="/ovirt-engine/api/groups/123/permissions" rel="permissions"/>
    <link href="/ovirt-engine/api/groups/123/tags" rel="tags"/>
    <domain_entry_id>476652557A382F67696B6D2B32762B37796E46476D513D3D</domain_entry_id>
    <namespace>DC=example,DC=com</namespace>
    <domain href="/ovirt-engine/api/domains/ABCDEF" id="ABCDEF">
      <name>myextension-authz</name>
    </domain>
  </group>
  ...
</groups>

반환된 그룹 목록의 순서는 보장되지 않습니다.

Expand
표 6.321. 매개변수 요약
이름유형방향요약

case_sensitive

부울

in

검색 매개 변수를 사용하여 수행된 검색이 대소문자를 고려하여 수행해야 하는지 여부를 나타냅니다.

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

groups

그룹 []

Out

그룹 목록.

max

정수

in

반환할 최대 그룹 수를 설정합니다.

search

문자열

in

반환된 그룹을 제한하는 데 사용되는 쿼리 문자열입니다.

6.107.2.1. case_sensitive

검색 매개 변수를 사용하여 수행된 검색이 대소문자를 고려하여 수행해야 하는지 여부를 나타냅니다. 기본값은 true 입니다. 즉, 해당 케이스가 고려됩니다. 대소문자를 무시하고자 하는 경우 false 로 설정합니다.

6.107.2.2. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.107.2.3. max

반환할 최대 그룹 수를 설정합니다. 지정하지 않으면 모든 그룹이 반환됩니다.

6.108. 호스트

호스트를 관리하는 서비스입니다.

Expand
표 6.322. 메서드 요약
이름요약

activate

예를 들어 가상 시스템을 실행하도록 호스트를 활성화합니다.

승인

가상화 환경에서 사용할 사전 설치된 Hypervisor 호스트를 승인합니다.

commitnetconfig

네트워크 구성을 적절하게 표시하고 호스트 내부에 유지합니다.

copyhostnetworks

지정된 호스트의 네트워크 구성을 현재 호스트에 복사합니다.

deactivate

유지 관리 작업을 수행하기 위해 호스트를 비활성화합니다.

discoveriscsi

이니시에이터 세부 정보를 사용하여 호스트에서 iSCSI 대상을 검색합니다.

enrollcertificate

호스트의 인증서를 등록합니다.

fence

호스트의 전원 관리 장치를 제어합니다.

forceselectspm

호스트를 수동으로 스토리지 풀 관리자(SPM)로 설정하려면.

get

호스트 세부 정보를 가져옵니다.

설치

호스트에 VDSM의 최신 버전 및 관련 소프트웨어를 설치합니다.

iscsidiscover

이 방법은 Engine 버전 4부터 사용되지 않습니다.

iscsilogin

대상 세부 정보를 사용하여 호스트의 iSCSI 대상에 로그인합니다.

새로 고침

호스트 장치 및 기능을 새로 고칩니다.

제거

시스템에서 호스트를 제거합니다.

setupnetworks

이 방법은 호스트의 네트워크 인터페이스 구성을 변경하는 데 사용됩니다.

syncallnetworks

호스트의 모든 네트워크를 동기화하려면 다음과 같은 요청을 보냅니다.

[source] ---- POST /ovirt-engine/api/hosts/123/syncallnetworks ----

다음과 같이 요청 본문이 있는 경우:

[source,xml] ---- <action/> ----

unregisteredstoragedomainsdiscover

설정으로 가져올 후보인 블록 스토리지 도메인을 검색합니다.

update

호스트 속성을 업데이트합니다.

upgrade

호스트에서 VDSM 및 선택한 소프트웨어를 업그레이드합니다.

upgradecheck

호스트에서 사용 가능한 업그레이드가 있는지 확인합니다.

6.108.1. POST활성화

예를 들어 가상 시스템을 실행하도록 호스트를 활성화합니다.

Expand
표 6.323. 매개변수 요약
이름유형방향요약

async

부울

in

활성화를 비동기적으로 수행해야 하는지 여부를 나타냅니다.

6.108.2. POST승인

가상화 환경에서 사용할 사전 설치된 Hypervisor 호스트를 승인합니다.

이 작업은 선택적 클러스터 요소도 허용하여 이 호스트의 대상 클러스터를 정의합니다.

Expand
표 6.324. 매개변수 요약
이름유형방향요약

activate

부울

in

'true'로 설정하면 승인이 완료되면 이 호스트가 활성화됩니다.

async

부울

in

승인을 비동기적으로 수행해야 하는지 여부를 나타냅니다.

cluster

Cluster

in

호스트가 승인된 후 추가할 클러스터입니다.

host

호스트

in

승인할 호스트입니다.

reboot

부울

in

설치가 성공한 후 호스트를 재부팅해야 하는지 여부를 나타냅니다.

6.108.2.1. 활성화

'true'로 설정하면 승인이 완료되면 이 호스트가 활성화됩니다. 'false'로 설정하면 호스트는 승인 후 '유지 관리' 상태로 유지됩니다. 이 매개 변수가 없으면 원하는 기본 동작이 승인 후 호스트를 활성화하는 것이므로 'true'로 해석됩니다.

6.108.2.2. reboot

설치가 성공한 후 호스트를 재부팅해야 하는지 여부를 나타냅니다. 기본값은 true입니다.

6.108.3. commitnetconfig POST

네트워크 구성을 적절하게 표시하고 호스트 내부에 유지합니다.

API 사용자는 네트워크 구성을 커밋하여 호스트 네트워크 인터페이스 연결 또는 분리를 지속하거나 결합된 인터페이스의 생성 및 삭제를 지속합니다.

중요

네트워킹 구성은 구성이 변경되면 엔진에서 호스트 연결이 손실되지 않도록 설정한 후에만 커밋됩니다. 호스트 연결이 끊어지면 호스트에 재부팅이 필요하며 이전 네트워킹 구성으로 자동 되돌아갑니다.

예를 들어 ID 123 을 사용하여 host의 네트워크 구성을 커밋하려면 다음과 같은 요청을 보냅니다.

POST /ovirt-engine/api/hosts/123/commitnetconfig

다음과 같이 요청 본문이 있는 경우:

<action/>
중요

Red Hat Virtualization Manager 4.3부터 setupnetworks 요청에 commit_on_success 를 지정할 수도 있습니다. 이 경우 설정을 완료하고 {hypervisor-name}과 Red Hat Virtualization Manager 간의 연결을 다시 설정하는 경우 별도의 commitnetconfig 요청을 기다리지 않고 새 설정이 자동으로 {hypervisor-name}에 저장됩니다.

Expand
표 6.325. 매개변수 요약
이름유형방향요약

async

부울

in

비동기적으로 작업을 수행해야 하는지 여부를 나타냅니다.Indicates whether the action should be performed asynchronously.

6.108.4. copyhostnetworks POST

지정된 호스트의 네트워크 구성을 현재 호스트에 복사합니다.

중요

소스 호스트에 없는 네트워크 첨부 파일은 복사 작업을 통해 대상 호스트에서 삭제됩니다.

다른 호스트에서 네트워크를 복사하려면 다음과 같은 요청을 보냅니다.

POST /ovirt-engine/api/hosts/123/copyhostnetworks

다음과 같이 요청 본문이 있는 경우:

<action>
   <source_host id="456"/>
</action>
Expand
표 6.326. 매개변수 요약
이름유형방향요약

async

부울

in

비동기적으로 작업을 수행해야 하는지 여부를 나타냅니다.Indicates whether the action should be performed asynchronously.

source_host

호스트

in

네트워크를 복사할 호스트입니다.

6.108.5. POST비활성화

유지 관리 작업을 수행하기 위해 호스트를 비활성화합니다.

Expand
표 6.327. 매개변수 요약
이름유형방향요약

async

부울

in

비활성화를 비동기적으로 수행해야 하는지 여부를 나타냅니다.

reason

문자열

in

 

stop_gluster_service

부울

in

gluster 서비스가 호스트 비활성화의 일부로 중지되어야 하는지 여부를 나타냅니다.

6.108.5.1. stop_gluster_service

gluster 서비스가 호스트 비활성화의 일부로 중지되어야 하는지 여부를 나타냅니다. gluster 호스트에서 유지 관리 작업을 수행하는 동안 사용할 수 있습니다. 이 변수의 기본값은 false 입니다.

6.108.6. iscsi POST검색

이니시에이터 세부 정보를 사용하여 호스트에서 iSCSI 대상을 검색합니다. 검색된 데이터가 포함된 IscsiDetails 오브젝트 목록을 반환합니다.

예를 들어 호스트 123 에서 myiscsi.example.com 에서 사용 가능한 iSCSI 대상을 검색하려면 다음과 같은 요청을 보냅니다.

POST /ovirt-engine/api/hosts/123/discoveriscsi

다음과 같이 요청 본문이 있는 경우:

<action>
  <iscsi>
    <address>myiscsi.example.com</address>
  </iscsi>
</action>

결과는 다음과 같습니다.

<discovered_targets>
  <iscsi_details>
    <address>10.35.1.72</address>
    <port>3260</port>
    <portal>10.35.1.72:3260,1</portal>
    <target>iqn.2015-08.com.tgt:444</target>
  </iscsi_details>
</discovered_targets>
중요

이 방법을 사용하여 iscsi 대상을 검색할 때 FQDN 또는 IP 주소를 사용할 수 있지만 검색된 대상 결과에서 iscsi details를 사용하여 iscsilogin 메서드를 사용해야 합니다.

Expand
표 6.328. 매개변수 요약
이름유형방향요약

async

부울

in

검색을 비동기적으로 수행해야 하는지 여부를 나타냅니다.Indicates if the discovery should be performed asynchronously.

discovered_targets

IscsiDetails[]

Out

모든 연결 정보를 포함한 검색된 대상입니다.

iscsi

IscsiDetails

in

대상 iSCSI 장치입니다.

6.108.7. Registercertificate POST

호스트의 인증서를 등록합니다. 만료되거나 이미 만료되었다는 경고가 발생하는 경우 유용합니다.

Expand
표 6.329. 매개변수 요약
이름유형방향요약

async

부울

in

등록을 비동기적으로 수행해야 하는지 여부를 나타냅니다.

6.108.8. fence POST

호스트의 전원 관리 장치를 제어합니다.

예를 들어 호스트를 시작하려면 다음을 수행합니다. 이 작업은 다음을 통해 수행할 수 있습니다.

#!/bin/sh -ex

url="https://engine.example.com/ovirt-engine/api"
user="admin@internal"
password="..."

curl \
--verbose \
--cacert /etc/pki/ovirt-engine/ca.pem \
--user "${user}:${password}" \
--request POST \
--header "Version: 4" \
--header "Content-Type: application/xml" \
--header "Accept: application/xml" \
--data '
<action>
  <fence_type>start</fence_type>
</action>
' \
"${url}/hosts/123/fence"
Expand
표 6.330. 매개변수 요약
이름유형방향요약

async

부울

in

펜싱을 비동기적으로 수행해야 하는지 여부를 나타냅니다.

fence_type

문자열

in

 

maintenance_after_restart

부울

in

재시작 후 호스트를 유지 관리해야 하는지 여부를 나타냅니다.

power_management

PowerManagement

Out

 

6.108.9. forceselectspm POST

호스트를 수동으로 스토리지 풀 관리자(SPM)로 설정하려면.

POST /ovirt-engine/api/hosts/123/forceselectspm

다음과 같이 요청 본문이 있는 경우:

<action/>
Expand
표 6.331. 매개변수 요약
이름유형방향요약

async

부울

in

비동기적으로 작업을 수행해야 하는지 여부를 나타냅니다.Indicates whether the action should be performed asynchronously.

6.108.10. GET가져오기

호스트 세부 정보를 가져옵니다.

GET /ovirt-engine/api/hosts/123
Expand
표 6.332. 매개변수 요약
이름유형방향요약

all_content

부울

in

호스트의 모든 특성이 응답에 포함되어야 하는지 여부를 나타냅니다.

filter

부울

in

사용자의 권한에 따라 결과를 필터링해야 하는지 여부를 나타냅니다.

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

host

호스트

Out

쿼리된 호스트입니다.

6.108.10.1. all_content

호스트의 모든 특성이 응답에 포함되어야 하는지 여부를 나타냅니다.

기본적으로 다음 속성은 제외됩니다.

  • hosted_engine

예를 들어 호스트 '123'의 전체 표시를 검색하려면 다음을 수행합니다.

GET /ovirt-engine/api/hosts/123?all_content=true
참고

이러한 특성을 검색하면 성능에 영향을 미치므로 기본적으로 포함되지 않습니다. 사용되지 않으며 데이터베이스에 대한 추가 쿼리가 필요합니다. 이 매개 변수는 주의해서 사용해야 하며 특히 필요한 경우에만 사용하십시오.

6.108.10.2. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.108.11. POST설치

호스트에 VDSM의 최신 버전 및 관련 소프트웨어를 설치합니다.

또한 이 작업은 호스트에 호스트를 추가하는 동안 수행되는 호스트의 모든 설정 단계(예: kdump 구성, 호스팅 엔진 배포, 커널 옵션 변경 등)를 수행합니다.

호스트 유형은 작업에 대한 추가 매개 변수를 정의합니다.

curl 및 JSON을 사용하여 호스트 설치 예:

curl \
--verbose \
--cacert /etc/pki/ovirt-engine/ca.pem \
--request PUT \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Version: 4" \
--user "admin@internal:..." \
--data '
{
  "root_password": "myrootpassword"
}
' \
"https://engine.example.com/ovirt-engine/api/hosts/123"

curl 및 호스팅 엔진 구성 요소가 있는 JSON을 사용하여 호스트 설치 예:

curl \
curl \
--verbose \
--cacert /etc/pki/ovirt-engine/ca.pem \
--request PUT \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Version: 4" \
--user "admin@internal:..." \
--data '
{
  "root_password": "myrootpassword"
"deploy_hosted_engine" : "true"
}
' \
"https://engine.example.com/ovirt-engine/api/hosts/123"
중요

엔진의 버전 4.1.2 이후, 호스트를 다시 설치할 때 기본적으로 호스트 방화벽 정의를 재정의합니다.

Expand
표 6.333. 매개변수 요약
이름유형방향요약

activate

부울

in

'true'로 설정하면 설치가 완료된 후 이 호스트가 활성화됩니다.

async

부울

in

설치를 비동기적으로 수행해야 하는지 여부를 나타냅니다.

deploy_hosted_engine

부울

in

true 로 설정하면 이 호스트는 자체 호스팅 엔진 구성 요소도 배포합니다.

host

호스트

in

override_iptables 속성은 방화벽 구성을 기본 구성으로 교체해야 하는지 여부를 나타내는 데 사용됩니다.

image

문자열

in

{hypervisor-name}을 설치할 때 ISO 이미지 파일이 필요합니다.

reboot

부울

in

설치가 성공한 후 호스트를 재부팅해야 하는지 여부를 나타냅니다.

root_password

문자열

in

SSH를 통해 호스트에 연결하는 데 사용되는 root 사용자의 암호입니다.

ssh

SSH

in

호스트에 연결하는 데 사용되는 SSH 세부 정보입니다.

undeploy_hosted_engine

부울

in

true 로 설정하면 이 호스트는 자체 호스팅 엔진 구성 요소를 배포 취소하며 이 호스트는 고가용성 클러스터의 일부로 작동하지 않습니다.

6.108.11.1. 활성화

'true'로 설정하면 설치가 완료된 후 이 호스트가 활성화됩니다. 'false'로 설정하면 호스트는 설치 후 '유지 관리' 상태로 유지됩니다. 이 매개 변수가 없으면 원하는 기본 동작이 설치 후 호스트를 활성화하는 것이므로 'true'로 해석됩니다.

6.108.11.2. deploy_hosted_engine

true 로 설정하면 이 호스트는 자체 호스팅 엔진 구성 요소도 배포합니다. 누락된 값은 True i.e deploy로 처리됩니다. 이 매개변수를 생략하면 false 를 의미하며 자체 호스팅 엔진 영역에서는 작업을 수행하지 않습니다.

6.108.11.3. reboot

설치가 성공한 후 호스트를 재부팅해야 하는지 여부를 나타냅니다. 기본값은 true입니다.

6.108.11.4. undeploy_hosted_engine

true 로 설정하면 이 호스트는 자체 호스팅 엔진 구성 요소를 배포 취소하며 이 호스트는 고가용성 클러스터의 일부로 작동하지 않습니다. 누락된 값은 true i.e 배포 취소로 처리됩니다. 이 매개변수를 생략하면 false 를 의미하며 자체 호스팅 엔진 영역에서는 작업을 수행하지 않습니다.

6.108.12. iscsidiscover POST

이 방법은 엔진 버전 4.4.6부터 사용되지 않습니다. 대신 DiscoverIscsi를 사용해야 합니다.

이니시에이터 세부 정보를 사용하여 호스트에서 iSCSI 대상을 검색합니다. 검색된 데이터가 포함된 문자열 배열을 반환합니다.

예를 들어 호스트 123 에서 myiscsi.example.com 에서 사용 가능한 iSCSI 대상을 검색하려면 다음과 같은 요청을 보냅니다.

POST /ovirt-engine/api/hosts/123/iscsidiscover

다음과 같이 요청 본문이 있는 경우:

<action>
  <iscsi>
    <address>myiscsi.example.com</address>
  </iscsi>
</action>
Expand
표 6.334. 매개변수 요약
이름유형방향요약

async

부울

in

검색을 비동기적으로 수행해야 하는지 여부를 나타냅니다.Indicates if the discovery should be performed asynchronously.

iscsi

IscsiDetails

in

대상 iSCSI 장치입니다.

iscsi_targets

문자열 []

Out

iSCSI 대상입니다.

6.108.12.1. iscsi_targets

iSCSI 대상입니다. *

6.108.13. iscsilogin POST

대상 세부 정보를 사용하여 호스트의 iSCSI 대상에 로그인합니다.

중요

이 방법을 사용하여 로그인하는 경우 검색된 대상의 iscsi 세부 정보를 사용해야 합니다. 검색된 대상의 iscsi 세부 정보를 사용해야 합니다.

Expand
표 6.335. 매개변수 요약
이름유형방향요약

async

부울

in

비동기적으로 로그인을 수행해야 하는지 여부를 나타냅니다.Indicates if the login should be performed asynchronously.

iscsi

IscsiDetails

in

대상 iSCSI 장치입니다.

6.108.14. POST새로 고침

호스트 장치 및 기능을 새로 고칩니다.

Expand
표 6.336. 매개변수 요약
이름유형방향요약

async

부울

in

새로 고침을 비동기적으로 수행해야 하는지 여부를 나타냅니다.Indicates if the refresh should be performed asynchronously.

6.108.15. DELETE제거

시스템에서 호스트를 제거합니다.

#!/bin/sh -ex

url="https://engine.example.com/ovirt-engine/api"
user="admin@internal"
password="..."

curl \
--verbose \
--cacert /etc/pki/ovirt-engine/ca.pem \
--user "${user}:${password}" \
--request DELETE \
--header "Version: 4" \
"${url}/hosts/1ff7a191-2f3b-4eff-812b-9f91a30c3acc"
Expand
표 6.337. 매개변수 요약
이름유형방향요약

async

부울

in

제거가 비동기적으로 수행되어야 하는지 여부를 나타냅니다.

force

부울

in

호스트가 분리되지 않거나 Gluster Storage 클러스터의 일부이고 볼륨 브릭이 있는 경우에도 호스트가 제거되어야 함을 나타냅니다.

6.108.16. setupnetworks POST

이 방법은 호스트의 네트워크 인터페이스 구성을 변경하는 데 사용됩니다.

예를 들어 네트워크 인터페이스 eth0,eth1eth2 가 있는 호스트가 있고 eth0eth1 을 사용하여 새 본딩을 구성하고 해당 호스트 위에 VLAN을 배치하려는 경우 다음을 수행합니다. 다음과 같이 수행할 수 있는 간단한 쉘 스크립트 및 curl 명령행 HTTP 클라이언트를 사용합니다.

#!/bin/sh -ex

url="https://engine.example.com/ovirt-engine/api"
user="admin@internal"
password="..."

curl \
--verbose \
--cacert /etc/pki/ovirt-engine/ca.pem \
--user "${user}:${password}" \
--request POST \
--header "Version: 4" \
--header "Content-Type: application/xml" \
--header "Accept: application/xml" \
--data '
<action>
  <modified_bonds>
    <host_nic>
      <name>bond0</name>
      <bonding>
        <options>
          <option>
            <name>mode</name>
            <value>4</value>
          </option>
          <option>
            <name>miimon</name>
            <value>100</value>
          </option>
        </options>
        <slaves>
          <host_nic>
            <name>eth1</name>
          </host_nic>
          <host_nic>
            <name>eth2</name>
          </host_nic>
        </slaves>
      </bonding>
    </host_nic>
  </modified_bonds>
  <modified_network_attachments>
    <network_attachment>
      <network>
        <name>myvlan</name>
      </network>
      <host_nic>
        <name>bond0</name>
      </host_nic>
      <ip_address_assignments>
        <ip_address_assignment>
          <assignment_method>static</assignment_method>
          <ip>
            <address>192.168.122.10</address>
            <netmask>255.255.255.0</netmask>
          </ip>
        </ip_address_assignment>
      </ip_address_assignments>
      <dns_resolver_configuration>
        <name_servers>
          <name_server>1.1.1.1</name_server>
          <name_server>2.2.2.2</name_server>
        </name_servers>
      </dns_resolver_configuration>
    </network_attachment>
  </modified_network_attachments>
 </action>
' \
"${url}/hosts/1ff7a191-2f3b-4eff-812b-9f91a30c3acc/setupnetworks"
참고

이는 API 버전 4에 적용됩니다. 이전 버전에서는 일부 요소가 XML 요소 대신 XML 속성으로 표시되었습니다. 특히 옵션ip 요소는 다음과 같이 표시됩니다.

<options name="mode" value="4"/>
<options name="miimon" value="100"/>
<ip address="192.168.122.10" netmask="255.255.255.0"/>

다음 코드와 함께 Python SDK를 사용하여 동일한 작업을 수행할 수 있습니다.

# Find the service that manages the collection of hosts:
hosts_service = connection.system_service().hosts_service()

# Find the host:
host = hosts_service.list(search='name=myhost')[0]

# Find the service that manages the host:
host_service = hosts_service.host_service(host.id)

# Configure the network adding a bond with two slaves and attaching it to a
# network with an static IP address:
host_service.setup_networks(
    modified_bonds=[
        types.HostNic(
            name='bond0',
            bonding=types.Bonding(
                options=[
                    types.Option(
                        name='mode',
                        value='4',
                    ),
                    types.Option(
                        name='miimon',
                        value='100',
                    ),
                ],
                slaves=[
                    types.HostNic(
                        name='eth1',
                    ),
                    types.HostNic(
                        name='eth2',
                    ),
                ],
            ),
        ),
    ],
    modified_network_attachments=[
        types.NetworkAttachment(
            network=types.Network(
                name='myvlan',
            ),
            host_nic=types.HostNic(
                name='bond0',
            ),
            ip_address_assignments=[
                types.IpAddressAssignment(
                    assignment_method=types.BootProtocol.STATIC,
                    ip=types.Ip(
                        address='192.168.122.10',
                        netmask='255.255.255.0',
                    ),
                ),
            ],
            dns_resolver_configuration=types.DnsResolverConfiguration(
                name_servers=[
                    '1.1.1.1',
                    '2.2.2.2',
                ],
            ),
        ),
    ],
)

# After modifying the network configuration it is very important to make it
# persistent:
host_service.commit_net_config()
중요

네트워크 구성이 호스트에 저장되고 호스트가 재부팅될 때 적용되는지 확인하려면 commitnetconfig 호출 .

중요

Red Hat Virtualization Manager 4.3부터 setupnetworks 요청에 commit_on_success 를 지정할 수도 있습니다. 이 경우 설정을 완료하고 {hypervisor-name}과 Red Hat Virtualization Manager 간의 연결을 다시 설정하는 경우 별도의 commitnetconfig 요청을 기다리지 않고 새 설정이 자동으로 {hypervisor-name}에 저장됩니다.

Expand
표 6.338. 매개변수 요약
이름유형방향요약

async

부울

in

비동기적으로 작업을 수행해야 하는지 여부를 나타냅니다.Indicates whether the action should be performed asynchronously.

check_connectivity

부울

in

 

commit_on_success

부울

in

별도의 commitnetconfig 요청을 기다리지 않고 설정 완료 후 {hypervisor-name}과 Red Hat Virtualization Manager 간의 연결을 다시 설정하는 경우 {hypervisor-name}에 구성을 자동으로 저장할지 여부를 지정합니다.

connectivity_timeout

정수

in

 

modified_bonds

HostNic[]

in

 

modified_labels

NetworkLabel[]

in

 

modified_network_attachments

NetworkAttachment[]

in

 

removed_bonds

HostNic[]

in

 

removed_labels

NetworkLabel[]

in

 

removed_network_attachments

NetworkAttachment[]

in

 

synchronized_network_attachments

NetworkAttachment[]

in

동기화될 네트워크 연결 목록입니다.

6.108.16.1. commit_on_success

별도의 commitnetconfig 요청을 기다리지 않고 설정 완료 후 {hypervisor-name}과 Red Hat Virtualization Manager 간의 연결을 다시 설정하는 경우 {hypervisor-name}에 구성을 자동으로 저장할지 여부를 지정합니다. 기본값은 false 입니다. 즉 구성이 자동으로 저장되지 않습니다.

6.108.17. syncallnetworks POST

호스트의 모든 네트워크를 동기화하려면 다음과 같은 요청을 보냅니다.

POST /ovirt-engine/api/hosts/123/syncallnetworks

다음과 같이 요청 본문이 있는 경우:

<action/>
Expand
표 6.339. 매개변수 요약
이름유형방향요약

async

부울

in

비동기적으로 작업을 수행해야 하는지 여부를 나타냅니다.Indicates whether the action should be performed asynchronously.

6.108.18. 등록되지 않은storagedomainsdiscover POST

설정으로 가져올 후보인 블록 스토리지 도메인을 검색합니다. FCP의 경우 인수가 필요하지 않습니다.

Expand
표 6.340. 매개변수 요약
이름유형방향요약

async

부울

in

검색을 비동기적으로 수행해야 하는지 여부를 나타냅니다.Indicates if the discovery should be performed asynchronously.

iscsi

IscsiDetails

in

 

storage_domains

StorageDomain[]

Out

 

6.108.19. PUT업데이트

호스트 속성을 업데이트합니다.

예를 들어 호스트의 커널 명령줄을 업데이트하려면 다음과 같은 요청을 보냅니다.

PUT /ovirt-engine/api/hosts/123

다음과 같이 요청 본문이 있는 경우:

<host>
  <os>
    <custom_kernel_cmdline>vfio_iommu_type1.allow_unsafe_interrupts=1</custom_kernel_cmdline>
  </os>
</host>
Expand
표 6.341. 매개변수 요약
이름유형방향요약

async

부울

in

업데이트를 비동기적으로 수행해야 하는지 여부를 나타냅니다.

host

호스트

in/Out

 

6.108.20. 업그레이드 POST

호스트에서 VDSM 및 선택한 소프트웨어를 업그레이드합니다.

Expand
표 6.342. 매개변수 요약
이름유형방향요약

async

부울

in

업그레이드를 비동기적으로 수행해야 하는지 여부를 나타냅니다.Indicates if the upgrade should be performed asynchronously.

image

문자열

in

Vintage Node는 더 이상 지원되지 않으며 더 이상 사용되지 않으므로 이 속성은 더 이상 관련이 없습니다.

reboot

부울

in

업그레이드 후 호스트를 재부팅해야 하는지 여부를 나타냅니다.

timeout

정수

in

업그레이드 제한 시간입니다.

6.108.20.1. reboot

업그레이드 후 호스트를 재부팅해야 하는지 여부를 나타냅니다. 기본적으로 호스트가 재부팅됩니다.

참고

이 매개변수는 업그레이드 후 항상 재부팅되는 {hypervisor-name}에 대해 무시됩니다.

6.108.20.2. timeout

업그레이드 제한 시간입니다.

업그레이드가 완료될 때까지 대기하는 최대 시간입니다. 기본값은 ANSIBLE_PLAYBOOK_EXEC_DEFAULT_TIMEOUT configration 옵션으로 지정됩니다.

6.108.21. upgradecheck POST

호스트에서 사용 가능한 업그레이드가 있는지 확인합니다. 사용 가능한 업그레이드가 있는 경우 관리 포털에서 호스트 상태 아이콘 옆에 아이콘이 표시됩니다. 감사 로그 메시지가 추가되어 업그레이드 가용성을 나타냅니다. 업그레이드는 webadmin 또는 업그레이드 호스트 작업을 사용하여 시작할 수 있습니다.

6.109. HostCpuUnits

Expand
표 6.343. 메서드 요약
이름요약

list

토폴로지(소켓, 코어)에 대한 세부 정보와 현재 CPU 고정에 대한 정보를 사용하여 모든 호스트 CPU 목록을 반환합니다.

6.109.1. GET나열

토폴로지(소켓, 코어)에 대한 세부 정보와 현재 CPU 고정에 대한 정보를 사용하여 모든 호스트 CPU 목록을 반환합니다.

Expand
표 6.344. 매개변수 요약
이름유형방향요약

cpu_units

HostCpuUnit[]

Out

 

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

6.109.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.110. HostDevice

호스트의 특정 장치에 액세스하는 서비스입니다.

Expand
표 6.345. 메서드 요약
이름요약

get

특정 호스트의 장치에 대한 정보를 검색합니다.

6.110.1. GET가져오기

특정 호스트의 장치에 대한 정보를 검색합니다.

호스트 장치를 가져오는 예:

GET /ovirt-engine/api/hosts/123/devices/456
<host_device href="/ovirt-engine/api/hosts/123/devices/456" id="456">
  <name>usb_1_9_1_1_0</name>
  <capability>usb</capability>
  <host href="/ovirt-engine/api/hosts/123" id="123"/>
  <parent_device href="/ovirt-engine/api/hosts/123/devices/789" id="789">
    <name>usb_1_9_1</name>
  </parent_device>
</host_device>
Expand
표 6.346. 매개변수 요약
이름유형방향요약

device

HostDevice

Out

 

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

6.110.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.111. HostDevices

호스트 장치에 액세스하는 서비스입니다.

Expand
표 6.347. 메서드 요약
이름요약

list

호스트 장치를 나열합니다.

6.111.1. GET나열

호스트 장치를 나열합니다.

반환된 장치 목록의 순서는 보장되지 않습니다.

Expand
표 6.348. 매개변수 요약
이름유형방향요약

장치

HostDevice[]

Out

 

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 최대 장치 수를 설정합니다.

6.111.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.111.1.2. max

반환할 최대 장치 수를 설정합니다. 지정하지 않으면 모든 장치가 반환됩니다.

6.112. HostHook

Expand
표 6.349. 메서드 요약
이름요약

get

 

6.112.1. GET가져오기

Expand
표 6.350. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

후크

후크

Out

 
6.112.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.113. HostHooks

Expand
표 6.351. 메서드 요약
이름요약

list

호스트에 구성된 후크 목록을 반환합니다.

6.113.1. GET나열

호스트에 구성된 후크 목록을 반환합니다.

반환된 후크 목록의 순서는 random합니다.

Expand
표 6.352. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

후크

Hook[]

Out

 

max

정수

in

반환할 최대 후크 수를 설정합니다.

6.113.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.113.1.2. max

반환할 최대 후크 수를 설정합니다. 지정하지 않으면 모든 후크가 반환됩니다.

6.114. HostNic

호스트의 네트워크 인터페이스를 관리하는 서비스입니다.

Expand
표 6.353. 메서드 요약
이름요약

get

 

updatevirtualfunctionsconfiguration

현재 리소스가 SR-IOV 지원 NIC를 나타내는 경우 작업에서는 가상 기능 구성을 업데이트합니다.

6.114.1. GET가져오기

Expand
표 6.354. 매개변수 요약
이름유형방향요약

all_content

부울

in

호스트 네트워크 인터페이스의 모든 특성이 응답에 포함되어야 하는지 여부를 나타냅니다.

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

nic

HostNic

Out

 
6.114.1.1. all_content

호스트 네트워크 인터페이스의 모든 특성이 응답에 포함되어야 하는지 여부를 나타냅니다.

기본적으로 다음 속성은 제외됩니다.

  • virtual_functions_configuration

예를 들어 호스트 '123'의 전체 표현 네트워크 인터페이스 '456'을 검색하려면 다음을 수행합니다.

GET /ovirt-engine/api/hosts/123/nics/456?all_content=true
참고

이러한 특성을 검색하면 성능에 영향을 미치므로 기본적으로 포함되지 않습니다. 사용되지 않으며 데이터베이스에 대한 추가 쿼리가 필요합니다. 이 매개 변수는 주의해서 사용해야 하며 특히 필요한 경우에만 사용하십시오.

6.114.1.2. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.114.2. updatevirtualfunctionsconfiguration POST

현재 리소스가 SR-IOV 지원 NIC를 나타내는 경우 작업에서는 가상 기능 구성을 업데이트합니다. 입력은 다음 속성 중 하나 이상으로 구성되어야 합니다.

  • allNetworksAllowed
  • numberOfVirtualFunctions

속성의 의미는 HostNicVirtualFunctionsConfiguration 유형을 참조하십시오.

Expand
표 6.355. 매개변수 요약
이름유형방향요약

async

부울

in

업데이트를 비동기적으로 수행해야 하는지 여부를 나타냅니다.

virtual_functions_configuration

HostNicVirtualFunctionsConfiguration

in

 

6.115. HostNics

호스트의 네트워크 인터페이스를 관리하는 서비스입니다.

Expand
표 6.356. 메서드 요약
이름요약

list

호스트의 네트워크 인터페이스 목록을 반환합니다.

6.115.1. GET나열

호스트의 네트워크 인터페이스 목록을 반환합니다.

반환된 네트워크 인터페이스 목록의 순서는 보장되지 않습니다.

Expand
표 6.357. 매개변수 요약
이름유형방향요약

all_content

부울

in

호스트 네트워크 인터페이스의 모든 특성이 응답에 포함되어야 하는지 여부를 나타냅니다.

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 최대 NIC 수를 설정합니다.

nics

HostNic[]

Out

 
6.115.1.1. all_content

호스트 네트워크 인터페이스의 모든 특성이 응답에 포함되어야 하는지 여부를 나타냅니다.

기본적으로 다음 속성은 제외됩니다.

  • virtual_functions_configuration

예를 들어 호스트 '123'의 네트워크 인터페이스 '456'의 전체 표시를 검색하려면 다음을 수행합니다.

GET /ovirt-engine/api/hosts/123/nics?all_content=true
참고

이러한 특성을 검색하면 성능에 영향을 미치므로 기본적으로 포함되지 않습니다. 사용되지 않으며 데이터베이스에 대한 추가 쿼리가 필요합니다. 이 매개 변수는 주의해서 사용해야 하며 특히 필요한 경우에만 사용하십시오.

6.115.1.2. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.115.1.3. max

반환할 최대 NIC 수를 설정합니다. 지정하지 않으면 모든 NIC가 반환됩니다.

6.116. HostNumaNode

Expand
표 6.358. 메서드 요약
이름요약

get

 

6.116.1. GET가져오기

Expand
표 6.359. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

node

ommaNode

Out

 
6.116.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.117. HostNumaNodes

Expand
표 6.360. 메서드 요약
이름요약

list

호스트의 NUMA 노드 목록을 반환합니다.

6.117.1. GET나열

호스트의 NUMA 노드 목록을 반환합니다.

반환된 NUMA 노드 목록의 순서는 보장되지 않습니다.

Expand
표 6.361. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 최대 노드 수를 설정합니다.

노드

NumaNode[]

Out

 
6.117.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.117.1.2. max

반환할 최대 노드 수를 설정합니다. 지정하지 않으면 모든 노드가 반환됩니다.

6.118. HostStorage

호스트 스토리지를 관리하는 서비스입니다.

Expand
표 6.362. 메서드 요약
이름요약

list

스토리지 목록 가져오기.

6.118.1. GET나열

스토리지 목록 가져오기.

GET /ovirt-engine/api/hosts/123/storage

얻을 수 있는 XML 응답은 다음과 같습니다.

<host_storages>
  <host_storage id="123">
    ...
  </host_storage>
  ...
</host_storages>

반환된 스토리지 목록의 순서는 보장되지 않습니다.

Expand
표 6.363. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

report_status

부울

in

스토리지에서 LUN의 상태를 확인해야 하는지 여부를 나타냅니다.

스토리지

HostStorage[]

Out

검색된 스토리지 목록입니다.

6.118.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.118.1.2. report_status

스토리지에서 LUN의 상태를 확인해야 하는지 여부를 나타냅니다. LUN의 상태를 확인하는 것은 중량 작업이며 이 데이터는 사용자가 항상 필요하지는 않습니다. 이 매개 변수는 LUN의 상태 검사를 수행하지 않는 옵션을 제공합니다.

이전 버전과의 호환성을 위해 기본값은 true 입니다.

다음은 LUN 상태의 예입니다.

<host_storage id="123">
  <logical_units>
    <logical_unit id="123">
      <lun_mapping>0</lun_mapping>
      <paths>1</paths>
      <product_id>lun0</product_id>
      <serial>123</serial>
      <size>10737418240</size>
      <status>used</status>
      <vendor_id>LIO-ORG</vendor_id>
      <volume_group_id>123</volume_group_id>
    </logical_unit>
  </logical_units>
  <type>iscsi</type>
  <host id="123"/>
</host_storage>

다음은 LUN 상태가 없는 예입니다.

<host_storage id="123">
  <logical_units>
    <logical_unit id="123">
      <lun_mapping>0</lun_mapping>
      <paths>1</paths>
      <product_id>lun0</product_id>
      <serial>123</serial>
      <size>10737418240</size>
      <vendor_id>LIO-ORG</vendor_id>
      <volume_group_id>123</volume_group_id>
    </logical_unit>
  </logical_units>
  <type>iscsi</type>
  <host id="123"/>
</host_storage>

6.119. 호스트

호스트를 관리하는 서비스입니다.

Expand
표 6.364. 메서드 요약
이름요약

add

새 호스트를 생성합니다.

list

사용 가능한 모든 호스트 목록을 가져옵니다.

6.119.1. POST추가

새 호스트를 생성합니다.

호스트는 호스트 매개 변수의 특성을 기반으로 생성됩니다. 이름,주소, root_password 속성이 필요합니다.

예를 들어 호스트를 추가하려면 다음 요청을 보냅니다.

POST /ovirt-engine/api/hosts

다음과 같은 요청 본문으로:

<host>
  <name>myhost</name>
  <address>myhost.example.com</address>
  <root_password>myrootpassword</root_password>
</host>
참고

root_password 요소는 클라이언트 제공 초기 표시에만 포함되며 후속 요청에서 반환된 표현에는 노출되지 않습니다.

중요

엔진의 버전 4.1.2 이후, 호스트가 새로 추가되면 호스트의 방화벽 정의가 기본적으로 재정의됩니다.

호스트 엔진 호스트를 추가하려면 deploy_hosted_engine 매개 변수를 사용합니다.

POST /ovirt-engine/api/hosts?deploy_hosted_engine=true

클러스터에 자동 배포에 지원되는 기본 외부 네트워크 공급자가 있는 경우 호스트를 추가할 때 외부 네트워크 공급자가 배포됩니다. OVN의 외부 네트워크 공급자만 자동 배포에 지원됩니다. 클러스터에 정의된 외부 네트워크 공급자가 아닌 다른 외부 네트워크 공급자를 배포하려면 다음 요청을 전송하여 호스트를 추가할 때 외부 네트워크 공급자를 덮어씁니다.

POST /ovirt-engine/api/hosts

external_network_provider_configuration 에서 원하는 공급자에 대한 참조가 포함된 요청 본문을 사용합니다.

<host>
  <name>myhost</name>
  <address>myhost.example.com</address>
  <root_password>123456</root_password>
  <external_network_provider_configurations>
    <external_network_provider_configuration>
      <external_network_provider name="ovirt-provider-ovn"/>
    </external_network_provider_configuration>
  </external_network_provider_configurations>
</host>
Expand
표 6.365. 매개변수 요약
이름유형방향요약

activate

부울

in

true 로 설정하면 설치가 완료된 후 이 호스트가 활성화됩니다.

deploy_hosted_engine

부울

in

true 로 설정하면 이 호스트는 호스팅 엔진 구성 요소를 배포합니다.

host

호스트

in/Out

새 호스트가 생성되는 호스트 정의가 매개 변수로 전달되고 새로 생성된 호스트가 반환됩니다.

reboot

부울

in

설치가 성공한 후 호스트를 재부팅해야 하는지 여부를 나타냅니다.

undeploy_hosted_engine

부울

in

true 로 설정하면 이 호스트는 호스팅 엔진 구성 요소를 배포 취소하며 고가용성 클러스터의 일부로 작동하지 않습니다.

6.119.1.1. 활성화

true 로 설정하면 설치가 완료된 후 이 호스트가 활성화됩니다. false 로 설정하면 호스트는 설치 후 유지 관리 상태로 유지됩니다. 이 매개 변수가 없으면 원하는 기본 동작이 설치 후 호스트를 활성화하는 것이므로 이 매개 변수가 true 로 해석됩니다.

6.119.1.2. deploy_hosted_engine

true 로 설정하면 이 호스트는 호스팅 엔진 구성 요소를 배포합니다. 누락된 값은 실제, 즉 호스팅 엔진 구성 요소를 배포합니다. 이 매개변수를 동일하게 생략하면 호스트 는 호스팅 엔진 영역에서 아무 작업도 수행하지 않습니다.

6.119.1.3. reboot

설치가 성공한 후 호스트를 재부팅해야 하는지 여부를 나타냅니다. 기본값은 true입니다.

6.119.1.4. undeploy_hosted_engine

true 로 설정하면 이 호스트는 호스팅 엔진 구성 요소를 배포 취소하며 고가용성 클러스터의 일부로 작동하지 않습니다. 누락된 값은 True, i.e., un-deploy로 처리됩니다. 이 매개변수를 동일하게 생략하면 호스트 는 호스팅 엔진 영역에서 아무 작업도 수행하지 않습니다.

6.119.2. GET나열

사용 가능한 모든 호스트 목록을 가져옵니다.

예를 들어, 호스트가 다음 요청을 전송하도록 하려면 다음을 수행합니다.

GET /ovirt-engine/api/hosts

응답 본문은 다음과 유사합니다.

<hosts>
  <host href="/ovirt-engine/api/hosts/123" id="123">
    ...
  </host>
  <host href="/ovirt-engine/api/hosts/456" id="456">
    ...
  </host>
  ...
</host>

반환된 호스트 목록의 순서는 sortby 절이 검색 매개 변수에 포함된 경우에만 보장됩니다.

Expand
표 6.366. 매개변수 요약
이름유형방향요약

all_content

부울

in

응답에 호스트 특성을 모두 포함해야 하는지 여부를 나타냅니다.

case_sensitive

부울

in

검색 매개 변수를 사용하여 수행된 검색이 대소문자를 고려하여 수행해야 하는지 여부를 나타냅니다.

check_vms_in_affinity_closure

부울

in

이 매개 변수를 migration_target_of 와 함께 사용하여 나열된 가상 머신과 나열된 가상 머신과 함께 양의 강제 적용 대상의 유효한 마이그레이션 대상을 가져올 수 있습니다.

filter

부울

in

사용자의 권한에 따라 결과를 필터링해야 하는지 여부를 나타냅니다.

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

호스트

Host[]

Out

 

max

정수

in

반환할 최대 호스트 수를 설정합니다.

migration_target_of

문자열

in

쉼표로 구분된 가상 시스템 ID 목록을 수락하고 이러한 가상 시스템을 마이그레이션할 수 있는 호스트를 반환합니다.

search

문자열

in

반환된 호스트를 제한하는 데 사용되는 쿼리 문자열입니다.

6.119.2.1. all_content

응답에 호스트 특성을 모두 포함해야 하는지 여부를 나타냅니다.

기본적으로 다음 호스트 속성은 제외됩니다.

  • hosted_engine

예를 들어 호스트의 전체 표현을 검색하려면 다음을 수행합니다.

GET /ovirt-engine/api/hosts?all_content=true
참고

이러한 특성을 검색하면 성능에 영향을 미치므로 기본적으로 포함되지 않습니다. 사용되지 않으며 데이터베이스에 대한 추가 쿼리가 필요합니다. 이 매개 변수는 주의해서 사용해야 하며 특히 필요한 경우에만 사용하십시오.

6.119.2.2. case_sensitive

검색 매개 변수를 사용하여 수행된 검색이 대소문자를 고려하여 수행해야 하는지 여부를 나타냅니다. 기본값은 true 입니다. 즉, 해당 케이스가 고려됩니다. 대소문자를 무시하고자 하는 경우 false 로 설정합니다.

6.119.2.3. check_vms_in_affinity_closure

이 매개 변수를 migration_target_of 와 함께 사용하여 나열된 가상 머신과 나열된 가상 머신과 함께 양의 강제 적용 대상의 유효한 마이그레이션 대상을 가져올 수 있습니다.

이는 양수 선호도 그룹의 다른 가상 머신과 함께 마이그레이션되는 경우에 유용합니다.

기본값은 false입니다.

GET /ovirt-engine/api/hosts?migration_target_of=123,456&check_vms_in_affinity_closure=true
6.119.2.4. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.119.2.5. max

반환할 최대 호스트 수를 설정합니다. 지정하지 않으면 모든 호스트가 반환됩니다.

6.119.2.6. migration_target_of

쉼표로 구분된 가상 시스템 ID 목록을 수락하고 이러한 가상 시스템을 마이그레이션할 수 있는 호스트를 반환합니다.

예를 들어 ID가 123인 가상 머신과 ID 456이 있는 가상 시스템을 마이그레이션할 수 있는 호스트 목록을 검색하려면 다음 요청을 보냅니다.

GET /ovirt-engine/api/hosts?migration_target_of=123,456

6.120. icon

아이콘(읽기 전용)을 관리하는 서비스입니다.

Expand
표 6.367. 메서드 요약
이름요약

get

아이콘을 가져옵니다.

6.120.1. GET가져오기

아이콘을 가져옵니다.

GET /ovirt-engine/api/icons/123

다음과 같은 XML 응답이 제공됩니다.

<icon id="123">
  <data>Some binary data here</data>
  <media_type>image/png</media_type>
</icon>
Expand
표 6.368. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

icon

icon

Out

검색된 아이콘.

6.120.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.121. icons

아이콘을 관리하는 서비스입니다.

Expand
표 6.369. 메서드 요약
이름요약

list

아이콘 목록을 가져옵니다.

6.121.1. GET나열

아이콘 목록을 가져옵니다.

GET /ovirt-engine/api/icons

다음과 유사한 XML 응답이 표시됩니다.

<icons>
  <icon id="123">
    <data>...</data>
    <media_type>image/png</media_type>
  </icon>
  ...
</icons>

반환된 아이콘 목록의 순서는 보장되지 않습니다.

Expand
표 6.370. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

icons

Icon[]

Out

검색된 아이콘 목록입니다.

max

정수

in

반환할 최대 아이콘 수를 설정합니다.

6.121.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.121.1.2. max

반환할 최대 아이콘 수를 설정합니다. 지정하지 않으면 모든 아이콘이 반환됩니다.

6.122. Image

Expand
표 6.371. 메서드 요약
이름요약

get

 

import

이미지를 가져옵니다.

6.122.1. GET가져오기

Expand
표 6.372. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

image

Image

Out

 
6.122.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.122.2. POST가져오기

이미지를 가져옵니다.

import_as_template 매개변수가 true 이면 이미지가 템플릿으로 가져오므로 디스크로 가져옵니다.

템플릿으로 가져올 때 템플릿 이름은 선택적 template.name 매개 변수로 지정할 수 있습니다. 해당 매개 변수를 지정하지 않으면 엔진에서 GlanceTemplate-x 로 템플릿의 이름을 자동으로 할당합니다(여기서 x 는 7개의 임의의 16진수 문자임).

디스크로 가져올 때 디스크 이름은 선택적 disk.name 매개 변수로 지정할 수 있습니다. 해당 매개 변수를 지정하지 않으면 엔진에서 GlanceDisk-x 로 자동으로 할당합니다(여기서 x 는 이미지 식별자의 일곱 16진수 문자임).

엔진에서 생성된 이러한 자동 이름을 방지하려면 항상 템플릿 또는 디스크 이름을 명시적으로 지정하는 것이 좋습니다.

Expand
표 6.373. 매개변수 요약
이름유형방향요약

async

부울

in

비동기적으로 가져오기를 수행해야 하는지 여부를 나타냅니다.Indicates if the import should be performed asynchronously.

cluster

Cluster

in

import_as_template 매개 변수가 true 로 설정된 경우 이미지를 가져올 클러스터입니다.

disk

디스크

in

가져올 디스크입니다.

import_as_template

부울

in

가져온 디스크에서 템플릿을 생성해야 하는지 여부를 지정합니다.

storage_domain

StorageDomain

in

디스크를 가져올 스토리지 도메인입니다.

template

템플릿

in

import_as_template 매개변수가 true 로 설정된 경우 생성되는 템플릿의 이름입니다.

6.123. ImageTransfer

이 서비스는 이미지 전송을 제어하는 메커니즘을 제공합니다. 클라이언트는 이미지 전송 서비스 추가를 사용하여 데이터를 전송 하도록 이미지를 지정하여 전송을 생성해야 합니다.

이렇게 하면 전송은 이 서비스에 의해 관리됩니다.

oVirt의 Python SDK 사용:

ID 123 을 사용하여 디스크 업로드(데이터 센터의 임의의 호스트)

transfers_service = system_service.image_transfers_service()
transfer = transfers_service.add(
   types.ImageTransfer(
      disk=types.Disk(
         id='123'
      )
   )
)

호스트 ID 456 에 id 123디스크 를 업로드 :

transfers_service = system_service.image_transfers_service()
transfer = transfers_service.add(
   types.ImageTransfer(
      disk=types.Disk(
         id='123'
      ),
      host=types.Host(
         id='456'
     )
   )
)

사용자가 업로드하지 않고 디스크를 다운로드하려는 경우 해당 사용자는 전송의 방향 속성으로 다운로드를 지정해야 합니다. 그러면 쓰기 권한 대신 이미지의 읽기 권한이 부여됩니다.

E.g:

transfers_service = system_service.image_transfers_service()
transfer = transfers_service.add(
   types.ImageTransfer(
      disk=types.Disk(
         id='123'
      ),
      direction=types.ImageTransferDirection.DOWNLOAD
   )
)

전송에는 업로드 / 다운로드의 흐름을 관리하는 단계가 있습니다. 이러한 흐름을 구현하는 클라이언트는 전송 단계를 폴링/확인하고 적절하게 수행해야 합니다. 가능한 모든 단계는 ImageTransferPhase 에서 찾을 수 있습니다.

새 전송을 추가한 후 해당 단계는 초기화 됩니다. 클라이언트는 변경될 때까지 전송 단계를 폴링해야 합니다. 단계가 전송 되면 세션은 전송을 시작할 준비가 되었습니다.

예를 들어 다음과 같습니다.

transfer_service = transfers_service.image_transfer_service(transfer.id)
while transfer.phase == types.ImageTransferPhase.INITIALIZING:
   time.sleep(3)
   transfer = transfer_service.get()

이 단계에서 전송 단계가 paused_system 인 경우 세션이 성공적으로 설정되지 않았습니다. 이 문제는 ovirt-imageio가 선택한 호스트에서 실행되지 않는 경우 발생할 수 있습니다.

Expand
표 6.374. 메서드 요약
이름요약

취소

이미지 전송 세션을 취소합니다.

extend

이미지 전송 세션을 확장합니다.

완료

데이터 전송을 완료한 후 전송을 완료합니다.

get

이미지 전송 엔터티를 가져옵니다.

pause

이미지 전송 세션을 일시 중지합니다.

resume

이미지 전송 세션을 다시 시작합니다.

6.123.1. POST취소

이미지 전송 세션을 취소합니다. 이렇게 하면 전송 작업이 종료되고 부분 이미지가 제거됩니다.

6.123.2. POST확장

이미지 전송 세션을 확장합니다.

6.123.3. 완료 POST

데이터 전송을 완료한 후 전송을 완료합니다.

이렇게 하면 전송 중인 데이터가 유효하고 전송 대상인 이미지 엔티티에 적합합니다. 특히, 이미지 엔티티가 QCOW 디스크인 경우 업로드된 데이터는 실제로 QCOW 파일이며 이미지에 백업 파일이 없는지 확인합니다.

6.123.4. GET가져오기

이미지 전송 엔터티를 가져옵니다.

Expand
표 6.375. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

image_transfer

ImageTransfer

Out

 
6.123.4.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.123.5. pause POST

이미지 전송 세션을 일시 중지합니다.

6.123.6. POST다시 시작

이미지 전송 세션을 다시 시작합니다. 클라이언트는 재시작하는 것과 다를 때까지 전송 단계를 폴링해야 합니다. 예를 들어 다음과 같습니다.

transfer_service = transfers_service.image_transfer_service(transfer.id)
transfer_service.resume()
transfer = transfer_service.get()

while transfer.phase == types.ImageTransferPhase.RESUMING:
   time.sleep(1)
   transfer = transfer_service.get()

6.124. ImageTransfers

이 서비스는 Red Hat Virtualization에서 이미지 I/O API 수행을 위한 이미지 전송을 관리합니다. 자세한 내용은 이미지 전송을 참조하십시오.

Expand
표 6.376. 메서드 요약
이름요약

add

새 이미지 전송을 추가합니다.

list

현재 수행 중인 이미지 전송 목록을 검색합니다.

6.124.1. POST추가

새 이미지 전송을 추가합니다. 새 전송을 수행하려면 이미지, 디스크 또는 디스크 스냅샷을 지정해야 합니다.

중요

image 속성은 엔진의 버전 4.2부터 더 이상 사용되지 않습니다. 대신 디스크 또는 스냅샷 속성을 사용합니다.

디스크 를 다운로드하거나 업로드하기 위한 새 이미지 전송 생성:

ID 123 으로 디스크를 다운로드하거나 업로드할 이미지 전송을 생성하려면 다음 요청을 보냅니다.

POST /ovirt-engine/api/imagetransfers

다음과 같이 요청 본문이 있는 경우:

<image_transfer>
  <disk id="123"/>
  <direction>upload|download</direction>
</image_transfer>

disk_snapshot 을 다운로드하거나 업로드하기 위한 새 이미지 전송 생성:

ID 456 을 사용하여 disk_snapshot 을 다운로드하거나 업로드하기 위한 이미지 전송을 생성하려면 다음 요청을 보냅니다.

POST /ovirt-engine/api/imagetransfers

다음과 같이 요청 본문이 있는 경우:

<image_transfer>
  <snapshot id="456"/>
  <direction>download|upload</direction>
</image_transfer>
Expand
표 6.377. 매개변수 요약
이름유형방향요약

image_transfer

ImageTransfer

in/Out

추가할 이미지를 전송합니다.

6.124.2. GET나열

현재 수행 중인 이미지 전송 목록을 검색합니다.

반환된 이미지 전송 목록의 순서는 보장되지 않습니다.

Expand
표 6.378. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

image_transfer

ImageTransfer[]

Out

현재 수행 중인 이미지 전송 목록입니다.

6.124.2.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.125. 이미지

스토리지 도메인 또는 OpenStack 이미지 공급자에서 사용할 수 있는 이미지 세트를 관리합니다.

Expand
표 6.379. 메서드 요약
이름요약

list

스토리지 도메인 또는 공급자에서 사용 가능한 이미지 목록을 반환합니다.

6.125.1. GET나열

스토리지 도메인 또는 공급자에서 사용 가능한 이미지 목록을 반환합니다.

반환된 이미지 목록의 순서는 보장되지 않습니다.

Expand
표 6.380. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

images

Image[]

Out

 

max

정수

in

반환할 최대 이미지 수를 설정합니다.

6.125.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.125.1.2. max

반환할 최대 이미지 수를 설정합니다. 지정하지 않으면 모든 이미지가 반환됩니다.

6.126. InstanceType

Expand
표 6.381. 메서드 요약
이름요약

get

특정 인스턴스 유형과 해당 특성을 가져옵니다.

제거

시스템에서 특정 인스턴스 유형을 제거합니다.

update

특정 인스턴스 유형 및 속성을 업데이트합니다.

6.126.1. GET가져오기

특정 인스턴스 유형과 해당 특성을 가져옵니다.

GET /ovirt-engine/api/instancetypes/123
Expand
표 6.382. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

instance_type

InstanceType

Out

 
6.126.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.126.2. DELETE제거

시스템에서 특정 인스턴스 유형을 제거합니다.

인스턴스 유형을 제거한 후 인스턴스 유형 X를 사용하여 가상 머신을 생성한 경우 가상 머신의 인스턴스 유형이 사용자 지정 으로 설정됩니다.

DELETE /ovirt-engine/api/instancetypes/123
Expand
표 6.383. 매개변수 요약
이름유형방향요약

async

부울

in

제거가 비동기적으로 수행되어야 하는지 여부를 나타냅니다.

6.126.3. PUT업데이트

특정 인스턴스 유형 및 속성을 업데이트합니다.

모든 속성은 생성 후 편집할 수 있습니다. 인스턴스 유형 X를 사용하여 가상 시스템을 만들고 인스턴스 유형 X의 일부 구성이 업데이트된 경우 엔진에 의해 가상 시스템의 구성이 자동으로 업데이트됩니다.

PUT /ovirt-engine/api/instancetypes/123

예를 들어 인스턴스 유형 123 의 메모리를 1GiB로 업데이트하고 cpu 토폴로지를 2소켓 2개 및 코어 1개로 설정하려면 다음과 같은 요청을 보냅니다.

<instance_type>
  <memory>1073741824</memory>
  <cpu>
    <topology>
      <cores>1</cores>
      <sockets>2</sockets>
      <threads>1</threads>
    </topology>
  </cpu>
</instance_type>
Expand
표 6.384. 매개변수 요약
이름유형방향요약

async

부울

in

업데이트를 비동기적으로 수행해야 하는지 여부를 나타냅니다.

instance_type

InstanceType

in/Out

 

6.127. InstanceTypeGraphicsConsole

Expand
표 6.385. 메서드 요약
이름요약

get

인스턴스 유형의 그래픽 콘솔 구성을 가져옵니다.

제거

인스턴스 유형에서 그래픽 콘솔을 제거합니다.

6.127.1. GET가져오기

인스턴스 유형의 그래픽 콘솔 구성을 가져옵니다.

Expand
표 6.386. 매개변수 요약
이름유형방향요약

console

GraphicsConsole

Out

인스턴스 유형의 그래픽 콘솔에 대한 정보입니다.

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

6.127.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.127.2. DELETE제거

인스턴스 유형에서 그래픽 콘솔을 제거합니다.

Expand
표 6.387. 매개변수 요약
이름유형방향요약

async

부울

in

제거가 비동기적으로 수행되어야 하는지 여부를 나타냅니다.

6.128. InstanceTypeGraphicsConsoles

Expand
표 6.388. 메서드 요약
이름요약

add

인스턴스 유형에 새 그래픽 콘솔을 추가합니다.

list

인스턴스 유형의 구성된 모든 그래픽 콘솔을 나열합니다.

6.128.1. POST추가

인스턴스 유형에 새 그래픽 콘솔을 추가합니다.

Expand
표 6.389. 매개변수 요약
이름유형방향요약

console

GraphicsConsole

in/Out

 

6.128.2. GET나열

인스턴스 유형의 구성된 모든 그래픽 콘솔을 나열합니다.

반환된 그래픽 콘솔 목록의 순서는 보장되지 않습니다.

Expand
표 6.390. 매개변수 요약
이름유형방향요약

콘솔

GraphicsConsole[]

Out

인스턴스 유형의 그래픽 콘솔 목록입니다.

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 최대 콘솔 수를 설정합니다.

6.128.2.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.128.2.2. max

반환할 최대 콘솔 수를 설정합니다. 지정하지 않으면 모든 콘솔이 반환됩니다.

6.129. InstanceTypeNic

Expand
표 6.391. 메서드 요약
이름요약

get

인스턴스 유형의 네트워크 인터페이스 구성을 가져옵니다.

제거

인스턴스 유형에서 네트워크 인터페이스를 제거합니다.

update

인스턴스 유형의 네트워크 인터페이스 구성을 업데이트합니다.

6.129.1. GET가져오기

인스턴스 유형의 네트워크 인터페이스 구성을 가져옵니다.

Expand
표 6.392. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

nic

NIC

Out

 
6.129.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.129.2. DELETE제거

인스턴스 유형에서 네트워크 인터페이스를 제거합니다.

Expand
표 6.393. 매개변수 요약
이름유형방향요약

async

부울

in

제거가 비동기적으로 수행되어야 하는지 여부를 나타냅니다.

6.129.3. PUT업데이트

인스턴스 유형의 네트워크 인터페이스 구성을 업데이트합니다.

Expand
표 6.394. 매개변수 요약
이름유형방향요약

async

부울

in

업데이트를 비동기적으로 수행해야 하는지 여부를 나타냅니다.

nic

NIC

in/Out

 

6.130. InstanceTypeNics

Expand
표 6.395. 메서드 요약
이름요약

add

인스턴스 유형에 새 네트워크 인터페이스를 추가합니다.

list

인스턴스 유형의 구성된 모든 네트워크 인터페이스를 나열합니다.

6.130.1. POST추가

인스턴스 유형에 새 네트워크 인터페이스를 추가합니다.

Expand
표 6.396. 매개변수 요약
이름유형방향요약

nic

NIC

in/Out

 

6.130.2. GET나열

인스턴스 유형의 구성된 모든 네트워크 인터페이스를 나열합니다.

반환된 네트워크 인터페이스 목록의 순서는 보장되지 않습니다.

Expand
표 6.397. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 최대 NIC 수를 설정합니다.

nics

NIC []

Out

 

search

문자열

in

반환된 템플릿을 제한하는 데 사용되는 쿼리 문자열입니다.

6.130.2.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.130.2.2. max

반환할 최대 NIC 수를 설정합니다. 지정하지 않으면 모든 NIC가 반환됩니다.

6.131. InstanceTypeWatchdog

Expand
표 6.398. 메서드 요약
이름요약

get

인스턴스 유형의 워치독 구성을 가져옵니다.

제거

인스턴스 유형에서 워치독을 제거합니다.

update

인스턴스 유형의 워치독 구성을 업데이트합니다.

6.131.1. GET가져오기

인스턴스 유형의 워치독 구성을 가져옵니다.

Expand
표 6.399. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

watchdog

Watchdog

Out

 
6.131.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.131.2. DELETE제거

인스턴스 유형에서 워치독을 제거합니다.

Expand
표 6.400. 매개변수 요약
이름유형방향요약

async

부울

in

제거가 비동기적으로 수행되어야 하는지 여부를 나타냅니다.

6.131.3. PUT업데이트

인스턴스 유형의 워치독 구성을 업데이트합니다.

Expand
표 6.401. 매개변수 요약
이름유형방향요약

async

부울

in

업데이트를 비동기적으로 수행해야 하는지 여부를 나타냅니다.

watchdog

Watchdog

in/Out

 

6.132. InstanceTypeWatchdogs

Expand
표 6.402. 메서드 요약
이름요약

add

인스턴스 유형에 새 워치독을 추가합니다.

list

인스턴스 유형의 구성된 모든 워치독을 나열합니다.

6.132.1. POST추가

인스턴스 유형에 새 워치독을 추가합니다.

Expand
표 6.403. 매개변수 요약
이름유형방향요약

watchdog

Watchdog

in/Out

 

6.132.2. GET나열

인스턴스 유형의 구성된 모든 워치독을 나열합니다.

반환된 워치독 목록의 순서는 보장되지 않습니다.

Expand
표 6.404. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 워치독의 최대 수를 설정합니다.

search

문자열

in

반환된 템플릿을 제한하는 데 사용되는 쿼리 문자열입니다.

watchdogs

Watchdog[]

Out

 
6.132.2.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.132.2.2. max

반환할 워치독의 최대 수를 설정합니다. 지정하지 않으면 모든 워치독이 반환됩니다.

6.133. InstanceTypes

Expand
표 6.405. 메서드 요약
이름요약

add

새 인스턴스 유형을 생성합니다.

list

시스템의 기존 인스턴스 유형을 모두 나열합니다.

6.133.1. POST추가

새 인스턴스 유형을 생성합니다.

이름 특성만 필요하며 가상 머신의 모든 하드웨어 구성을 포함할 수 있습니다.

POST /ovirt-engine/api/instancetypes

다음과 같이 요청 본문이 있는 경우:

<instance_type>
  <name>myinstancetype</name>
</template>

요청 본문을 다음과 같이 모든 하드웨어 구성으로 인스턴스 유형을 생성합니다.

<instance_type>
  <name>myinstancetype</name>
  <console>
    <enabled>true</enabled>
  </console>
  <cpu>
    <topology>
      <cores>2</cores>
      <sockets>2</sockets>
      <threads>1</threads>
    </topology>
  </cpu>
  <custom_cpu_model>AMD Opteron_G2</custom_cpu_model>
  <custom_emulated_machine>q35</custom_emulated_machine>
  <display>
    <monitors>1</monitors>
    <single_qxl_pci>true</single_qxl_pci>
    <smartcard_enabled>true</smartcard_enabled>
    <type>spice</type>
  </display>
  <high_availability>
    <enabled>true</enabled>
    <priority>1</priority>
  </high_availability>
  <io>
    <threads>2</threads>
  </io>
  <memory>4294967296</memory>
  <memory_policy>
    <ballooning>true</ballooning>
    <guaranteed>268435456</guaranteed>
  </memory_policy>
  <migration>
    <auto_converge>inherit</auto_converge>
    <compressed>inherit</compressed>
    <policy id="00000000-0000-0000-0000-000000000000"/>
  </migration>
  <migration_downtime>2</migration_downtime>
  <os>
    <boot>
      <devices>
        <device>hd</device>
      </devices>
    </boot>
  </os>
  <rng_device>
    <rate>
      <bytes>200</bytes>
      <period>2</period>
    </rate>
    <source>urandom</source>
  </rng_device>
  <soundcard_enabled>true</soundcard_enabled>
  <usb>
    <enabled>true</enabled>
    <type>native</type>
  </usb>
  <virtio_scsi>
    <enabled>true</enabled>
  </virtio_scsi>
</instance_type>
Expand
표 6.406. 매개변수 요약
이름유형방향요약

instance_type

InstanceType

in/Out

 

6.133.2. GET나열

시스템의 기존 인스턴스 유형을 모두 나열합니다.

반환된 인스턴스 유형 목록의 순서는 보장되지 않습니다.

Expand
표 6.407. 매개변수 요약
이름유형방향요약

case_sensitive

부울

in

검색 매개 변수를 사용하여 수행된 검색이 대소문자를 고려하여 수행해야 하는지 여부를 나타냅니다.

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

instance_type

InstanceType[]

Out

 

max

정수

in

반환할 최대 인스턴스 유형 수를 설정합니다.

search

문자열

in

반환된 템플릿을 제한하는 데 사용되는 쿼리 문자열입니다.

6.133.2.1. case_sensitive

검색 매개 변수를 사용하여 수행된 검색이 대소문자를 고려하여 수행해야 하는지 여부를 나타냅니다. 기본값은 true 입니다. 즉, 해당 케이스가 고려됩니다. 대소문자를 무시하고자 하는 경우 false 로 설정합니다.

6.133.2.2. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.133.2.3. max

반환할 최대 인스턴스 유형 수를 설정합니다. 지정하지 않으면 모든 인스턴스 유형이 반환됩니다.

6.134. IscsiBond

Expand
표 6.408. 메서드 요약
이름요약

get

 

제거

기존 iSCSI 본딩을 제거합니다.

update

iSCSI 본딩 업데이트.

6.134.1. GET가져오기

Expand
표 6.409. 매개변수 요약
이름유형방향요약

본딩

IscsiBond

Out

iSCSI 본딩.

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

6.134.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.134.2. DELETE제거

기존 iSCSI 본딩을 제거합니다.

예를 들어 iSCSI 본딩 456 을 제거하려면 다음과 같은 요청을 보냅니다.

DELETE /ovirt-engine/api/datacenters/123/iscsibonds/456
Expand
표 6.410. 매개변수 요약
이름유형방향요약

async

부울

in

제거가 비동기적으로 수행되어야 하는지 여부를 나타냅니다.

6.134.3. PUT업데이트

iSCSI 본딩 업데이트.

iSCSI 본딩 업데이트는 이름설명 속성에서만 수행할 수 있습니다. 예를 들어 데이터 센터( 123 )의 iSCSI 본딩 456 을 업데이트하려면 다음과 같은 요청을 보냅니다.

PUT /ovirt-engine/api/datacenters/123/iscsibonds/1234

요청 본문은 다음과 같아야 합니다.

<iscsi_bond>
   <name>mybond</name>
   <description>My iSCSI bond</description>
</iscsi_bond>
Expand
표 6.411. 매개변수 요약
이름유형방향요약

async

부울

in

업데이트를 비동기적으로 수행해야 하는지 여부를 나타냅니다.

본딩

IscsiBond

in/Out

업데이트할 iSCSI 본딩입니다.

6.135. IscsiBonds

Expand
표 6.412. 메서드 요약
이름요약

add

데이터 센터에서 새 iSCSI 본딩을 생성합니다.

list

데이터 센터에 구성된 iSCSI 본딩 목록을 반환합니다.

6.135.1. POST추가

데이터 센터에서 새 iSCSI 본딩을 생성합니다.

예를 들어 스토리지 연결 456789 를 사용하여 데이터 센터( 123 )에 새 iSCSI 본딩을 생성하려면 다음과 같은 요청을 보냅니다.

POST /ovirt-engine/api/datacenters/123/iscsibonds

요청 본문은 다음과 같아야 합니다.

<iscsi_bond>
  <name>mybond</name>
  <storage_connections>
    <storage_connection id="456"/>
    <storage_connection id="789"/>
  </storage_connections>
  <networks>
    <network id="abc"/>
  </networks>
</iscsi_bond>
Expand
표 6.413. 매개변수 요약
이름유형방향요약

본딩

IscsiBond

in/Out

 

6.135.2. GET나열

데이터 센터에 구성된 iSCSI 본딩 목록을 반환합니다.

iSCSI 본딩의 반환 목록 순서는 보장되지 않습니다.

Expand
표 6.414. 매개변수 요약
이름유형방향요약

본딩

IscsiBond[]

Out

 

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 최대 본딩 수를 설정합니다.

6.135.2.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.135.2.2. max

반환할 최대 본딩 수를 설정합니다. 지정하지 않으면 모든 본딩이 반환됩니다.

6.136. 작업

작업을 관리하는 서비스입니다.

Expand
표 6.415. 메서드 요약
이름요약

clear

외부 작업 실행을 시스템에서 삭제하도록 설정합니다.

end

외부 작업 실행이 종료된 것으로 표시합니다.

get

작업을 검색합니다.

6.136.1. POST지우기

외부 작업 실행을 시스템에서 삭제하도록 설정합니다.

예를 들어 식별자가 123 인 작업을 설정하려면 다음 요청을 보냅니다.

POST /ovirt-engine/api/jobs/clear

다음과 같은 요청 본문으로:

<action/>
Expand
표 6.416. 매개변수 요약
이름유형방향요약

async

부울

in

비동기적으로 작업을 수행해야 하는지 여부를 나타냅니다.Indicates whether the action should be performed asynchronously.

6.136.2. end POST

외부 작업 실행이 종료된 것으로 표시합니다.

예를 들어 식별자가 123 인 작업을 종료하려면 다음 요청을 보냅니다.

POST /ovirt-engine/api/jobs/end

다음과 같은 요청 본문으로:

<action>
  <force>true</force>
  <status>finished</status>
</action>
Expand
표 6.417. 매개변수 요약
이름유형방향요약

async

부울

in

비동기적으로 작업을 수행해야 하는지 여부를 나타냅니다.Indicates whether the action should be performed asynchronously.

force

부울

in

작업이 강제 종료되어야 하는지 여부를 나타냅니다.

succeeded

부울

in

작업이 성공적으로 완료됨 또는 실패로 표시되어야 하는지 여부를 나타냅니다.

6.136.2.1. succeeded

작업이 성공적으로 완료됨 또는 실패로 표시되어야 하는지 여부를 나타냅니다.

이 매개변수는 선택 사항이며 기본값은 true 입니다.

6.136.3. GET가져오기

작업을 검색합니다.

GET /ovirt-engine/api/jobs/123

다음과 같은 XML로 응답을 받습니다.

<job href="/ovirt-engine/api/jobs/123" id="123">
  <actions>
    <link href="/ovirt-engine/api/jobs/123/clear" rel="clear"/>
    <link href="/ovirt-engine/api/jobs/123/end" rel="end"/>
  </actions>
  <description>Adding Disk</description>
  <link href="/ovirt-engine/api/jobs/123/steps" rel="steps"/>
  <auto_cleared>true</auto_cleared>
  <end_time>2016-12-12T23:07:29.758+02:00</end_time>
  <external>false</external>
  <last_updated>2016-12-12T23:07:29.758+02:00</last_updated>
  <start_time>2016-12-12T23:07:26.593+02:00</start_time>
  <status>failed</status>
  <owner href="/ovirt-engine/api/users/456" id="456"/>
</job>
Expand
표 6.418. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

job

작업

Out

작업의 표현을 검색합니다.

6.136.3.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.137. 작업

작업을 관리하는 서비스입니다.

Expand
표 6.419. 메서드 요약
이름요약

add

외부 작업을 추가합니다.

list

작업 표현을 검색합니다.

6.137.1. POST추가

외부 작업을 추가합니다.

예를 들어 다음 요청이 있는 작업을 추가하려면 다음을 수행합니다.

POST /ovirt-engine/api/jobs

다음과 같은 요청 본문으로:

<job>
  <description>Doing some work</description>
  <auto_cleared>true</auto_cleared>
</job>

응답은 다음과 같아야 합니다.

<job href="/ovirt-engine/api/jobs/123" id="123">
  <actions>
    <link href="/ovirt-engine/api/jobs/123/clear" rel="clear"/>
    <link href="/ovirt-engine/api/jobs/123/end" rel="end"/>
  </actions>
  <description>Doing some work</description>
  <link href="/ovirt-engine/api/jobs/123/steps" rel="steps"/>
  <auto_cleared>true</auto_cleared>
  <external>true</external>
  <last_updated>2016-12-13T02:15:42.130+02:00</last_updated>
  <start_time>2016-12-13T02:15:42.130+02:00</start_time>
  <status>started</status>
  <owner href="/ovirt-engine/api/users/456" id="456"/>
</job>
Expand
표 6.420. 매개변수 요약
이름유형방향요약

job

작업

in/Out

추가할 작업입니다.

6.137.2. GET나열

작업 표현을 검색합니다.

GET /ovirt-engine/api/jobs

다음과 같은 XML로 응답을 받습니다.

<jobs>
  <job href="/ovirt-engine/api/jobs/123" id="123">
    <actions>
      <link href="/ovirt-engine/api/jobs/123/clear" rel="clear"/>
      <link href="/ovirt-engine/api/jobs/123/end" rel="end"/>
    </actions>
    <description>Adding Disk</description>
    <link href="/ovirt-engine/api/jobs/123/steps" rel="steps"/>
    <auto_cleared>true</auto_cleared>
    <end_time>2016-12-12T23:07:29.758+02:00</end_time>
    <external>false</external>
    <last_updated>2016-12-12T23:07:29.758+02:00</last_updated>
    <start_time>2016-12-12T23:07:26.593+02:00</start_time>
    <status>failed</status>
    <owner href="/ovirt-engine/api/users/456" id="456"/>
  </job>
  ...
</jobs>

반환된 작업 목록의 순서는 보장되지 않습니다.

Expand
표 6.421. 매개변수 요약
이름유형방향요약

case_sensitive

부울

in

검색 매개 변수를 사용하여 수행된 검색이 대소문자를 고려하여 수행해야 하는지 여부를 나타냅니다.

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

jobs

Job[]

Out

작업 표현입니다.

max

정수

in

반환할 최대 작업 수를 설정합니다.

search

문자열

in

반환된 작업을 제한하는 데 사용되는 쿼리 문자열입니다.

6.137.2.1. case_sensitive

검색 매개 변수를 사용하여 수행된 검색이 대소문자를 고려하여 수행해야 하는지 여부를 나타냅니다. 기본값은 true 입니다. 즉, 해당 케이스가 고려됩니다. 대소문자를 무시하고자 하는 경우 false 로 설정합니다.

6.137.2.2. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.137.2.3. max

반환할 최대 작업 수를 설정합니다. 지정하지 않으면 모든 작업이 반환됩니다.

6.138. KatelloErrata

Katello 에라타를 관리하는 서비스입니다. 해당 정보는 Katello에서 검색됩니다.

Expand
표 6.422. 메서드 요약
이름요약

list

Katello 에라타의 표현을 검색합니다.

6.138.1. GET나열

Katello 에라타의 표현을 검색합니다.

GET /ovirt-engine/api/katelloerrata

다음과 같은 XML로 응답을 받습니다.

<katello_errata>
  <katello_erratum href="/ovirt-engine/api/katelloerrata/123" id="123">
    <name>RHBA-2013:XYZ</name>
    <description>The description of the erratum</description>
    <title>some bug fix update</title>
    <type>bugfix</type>
    <issued>2013-11-20T02:00:00.000+02:00</issued>
    <solution>Few guidelines regarding the solution</solution>
    <summary>Updated packages that fix one bug are now available for XYZ</summary>
    <packages>
      <package>
        <name>libipa_hbac-1.9.2-82.11.el6_4.i686</name>
      </package>
      ...
    </packages>
  </katello_erratum>
  ...
</katello_errata>

반환된 에라타 목록의 순서는 보장되지 않습니다.

Expand
표 6.423. 매개변수 요약
이름유형방향요약

errata

KatelloErratum[]

Out

Katello 에라타의 표현입니다.

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 최대 에라타 수를 설정합니다.

6.138.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.138.1.2. max

반환할 최대 에라타 수를 설정합니다. 지정하지 않으면 에라타가 모두 반환됩니다.

6.139. KatelloErratum

Katello 에라타를 관리하는 서비스입니다.

Expand
표 6.424. 메서드 요약
이름요약

get

Katello 에라타를 검색합니다.

6.139.1. GET가져오기

Katello 에라타를 검색합니다.

GET /ovirt-engine/api/katelloerrata/123

다음과 같은 XML로 응답을 받습니다.

<katello_erratum href="/ovirt-engine/api/katelloerrata/123" id="123">
  <name>RHBA-2013:XYZ</name>
  <description>The description of the erratum</description>
  <title>some bug fix update</title>
  <type>bugfix</type>
  <issued>2013-11-20T02:00:00.000+02:00</issued>
  <solution>Few guidelines regarding the solution</solution>
  <summary>Updated packages that fix one bug are now available for XYZ</summary>
  <packages>
    <package>
      <name>libipa_hbac-1.9.2-82.11.el6_4.i686</name>
    </package>
    ...
  </packages>
</katello_erratum>
Expand
표 6.425. 매개변수 요약
이름유형방향요약

erratum

KatelloErratum

Out

Katello 에라타의 표현을 검색합니다.

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

6.139.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.141. MacPool

Expand
표 6.428. 메서드 요약
이름요약

get

 

제거

MAC 주소 풀을 제거합니다.

update

MAC 주소 풀을 업데이트합니다.

6.141.1. GET가져오기

Expand
표 6.429. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

pool

MacPool

Out

 
6.141.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.141.2. DELETE제거

MAC 주소 풀을 제거합니다.

예를 들어 ID가 123 인 MAC 주소 풀을 제거하려면 다음과 같이 요청을 보냅니다.

DELETE /ovirt-engine/api/macpools/123
Expand
표 6.430. 매개변수 요약
이름유형방향요약

async

부울

in

제거가 비동기적으로 수행되어야 하는지 여부를 나타냅니다.

6.141.3. PUT업데이트

MAC 주소 풀을 업데이트합니다.

이름,설명,allow_duplicatesranges 속성을 업데이트할 수 있습니다.

예를 들어 ID 123 의 MAC 주소 풀을 업데이트하려면 다음과 같은 요청을 보냅니다.

PUT /ovirt-engine/api/macpools/123

다음과 같이 요청 본문이 있는 경우:

<mac_pool>
  <name>UpdatedMACPool</name>
  <description>An updated MAC address pool</description>
  <allow_duplicates>false</allow_duplicates>
  <ranges>
    <range>
      <from>00:1A:4A:16:01:51</from>
      <to>00:1A:4A:16:01:e6</to>
    </range>
    <range>
      <from>02:1A:4A:01:00:00</from>
      <to>02:1A:4A:FF:FF:FF</to>
    </range>
  </ranges>
</mac_pool>
Expand
표 6.431. 매개변수 요약
이름유형방향요약

async

부울

in

업데이트를 비동기적으로 수행해야 하는지 여부를 나타냅니다.

pool

MacPool

in/Out

 

6.142. MacPools

Expand
표 6.432. 메서드 요약
이름요약

add

새 MAC 주소 풀을 생성합니다.

list

시스템의 MAC 주소 풀 목록을 반환합니다.

6.142.1. POST추가

새 MAC 주소 풀을 생성합니다.

MAC 주소 풀을 생성하려면 이름범위 특성에 대한 값이 필요합니다.

예를 들어 MAC 주소 풀을 생성하려면 다음과 같은 요청을 보냅니다.

POST /ovirt-engine/api/macpools

다음과 같이 요청 본문이 있는 경우:

<mac_pool>
  <name>MACPool</name>
  <description>A MAC address pool</description>
  <allow_duplicates>true</allow_duplicates>
  <default_pool>false</default_pool>
  <ranges>
    <range>
      <from>00:1A:4A:16:01:51</from>
      <to>00:1A:4A:16:01:e6</to>
    </range>
  </ranges>
</mac_pool>
Expand
표 6.433. 매개변수 요약
이름유형방향요약

pool

MacPool

in/Out

 

6.142.2. GET나열

시스템의 MAC 주소 풀 목록을 반환합니다.

MAC 주소 풀의 반환된 목록은 보장되지 않습니다.

Expand
표 6.434. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 최대 풀 수를 설정합니다.

pool

MacPool[]

Out

 
6.142.2.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.142.2.2. max

반환할 최대 풀 수를 설정합니다. 지정하지 않으면 모든 풀이 반환됩니다.

6.143. Measurable

6.144. 이동 가능

Expand
표 6.435. 메서드 요약
이름요약

이동

 

6.144.1. POST이동

Expand
표 6.436. 매개변수 요약
이름유형방향요약

async

부울

in

비동기적으로 이동을 수행할지 여부를 나타냅니다.Indicates if the move should be performed asynchronously.

6.145. 네트워크

네트워크를 관리하는 서비스

Expand
표 6.437. 메서드 요약
이름요약

get

논리적 네트워크를 가져옵니다.

제거

논리적 네트워크 또는 논리적 네트워크의 데이터 센터에 대한 연결을 제거합니다.

update

논리적 네트워크를 업데이트합니다.

6.145.1. GET가져오기

논리적 네트워크를 가져옵니다.

예를 들어 다음과 같습니다.

GET /ovirt-engine/api/networks/123

응답일 것입니다:

<network href="/ovirt-engine/api/networks/123" id="123">
  <name>ovirtmgmt</name>
  <description>Default Management Network</description>
  <link href="/ovirt-engine/api/networks/123/permissions" rel="permissions"/>
  <link href="/ovirt-engine/api/networks/123/vnicprofiles" rel="vnicprofiles"/>
  <link href="/ovirt-engine/api/networks/123/networklabels" rel="networklabels"/>
  <mtu>0</mtu>
  <stp>false</stp>
  <usages>
    <usage>vm</usage>
  </usages>
  <data_center href="/ovirt-engine/api/datacenters/456" id="456"/>
</network>
Expand
표 6.438. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

network

네트워크

Out

 
6.145.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.145.2. DELETE제거

논리적 네트워크 또는 논리적 네트워크의 데이터 센터에 대한 연결을 제거합니다.

예를 들어 논리적 네트워크( 123 )를 제거하려면 다음과 같은 요청을 보냅니다.

DELETE /ovirt-engine/api/networks/123

각 네트워크는 정확히 하나의 데이터 센터에 바인딩됩니다. 따라서 데이터 센터를 사용하여 네트워크를 연결 해제하면 해당 네트워크를 삭제하는 것과 동일합니다. 그러나 데이터 센터( 123 )의 네트워크( 456 )를 제거하고 있다고 가정하는 것이 더 구체적일 수 있습니다.

예를 들어 네트워크(4656)의 연결을 데이터 센터( 123 )로 제거하려면 다음과 같은 요청을 보냅니다.

DELETE /ovirt-engine/api/datacenters/123/networks/456
참고

외부 논리적 네트워크를 제거하려면 OpenStack Networking API 에서 네트워크를 프로바이더에서 직접 제거해야 합니다. Red Hat Virtualization 내에서 외부 네트워크를 나타내는 엔터티가 자동으로 제거됩니다. 공급자에 auto_sync 가 활성화된 경우 이 방법을 사용하여 엔터티를 제거해야 합니다.

Expand
표 6.439. 매개변수 요약
이름유형방향요약

async

부울

in

제거가 비동기적으로 수행되어야 하는지 여부를 나타냅니다.

6.145.3. PUT업데이트

논리적 네트워크를 업데이트합니다.

이름,설명,ip,vlan,stpdisplay 속성을 업데이트할 수 있습니다.

예를 들어 논리적 네트워크( 123 )에 대한 설명을 업데이트하려면 다음과 같은 요청을 보냅니다.

PUT /ovirt-engine/api/networks/123

다음과 같이 요청 본문이 있는 경우:

<network>
  <description>My updated description</description>
</network>

네트워크의 최대 전송 단위는 PUT 요청을 사용하여 mtu 속성의 정수 값을 지정합니다.

예를 들어 최대 전송 단위를 설정하려면 다음과 같은 요청을 보냅니다.

PUT /ovirt-engine/api/datacenters/123/networks/456

다음과 같이 요청 본문이 있는 경우:

<network>
  <mtu>1500</mtu>
</network>
참고

외부 네트워크 업데이트는 공급자로 전달되지 않습니다.

Expand
표 6.440. 매개변수 요약
이름유형방향요약

async

부울

in

업데이트를 비동기적으로 수행해야 하는지 여부를 나타냅니다.

network

네트워크

in/Out

 

6.146. NetworkAttachment

Expand
표 6.441. 메서드 요약
이름요약

get

 

제거

 

update

호스트에서 지정된 네트워크 연결을 업데이트합니다.

6.146.1. GET가져오기

Expand
표 6.442. 매개변수 요약
이름유형방향요약

첨부 파일

NetworkAttachment

Out

 

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

6.146.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.146.2. DELETE제거

Expand
표 6.443. 매개변수 요약
이름유형방향요약

async

부울

in

제거가 비동기적으로 수행되어야 하는지 여부를 나타냅니다.

6.146.3. PUT업데이트

호스트에서 지정된 네트워크 연결을 업데이트합니다.

Expand
표 6.444. 매개변수 요약
이름유형방향요약

async

부울

in

업데이트를 비동기적으로 수행해야 하는지 여부를 나타냅니다.

첨부 파일

NetworkAttachment

in/Out

 

6.147. NetworkAttachments

호스트 또는 호스트 NIC의 네트워크 연결 세트를 관리합니다.

Expand
표 6.445. 메서드 요약
이름요약

add

네트워크 인터페이스에 새 네트워크 연결을 추가합니다.

list

호스트 또는 호스트 NIC의 네트워크 연결 목록을 반환합니다.

6.147.1. POST추가

네트워크 인터페이스에 새 네트워크 연결을 추가합니다.

Expand
표 6.446. 매개변수 요약
이름유형방향요약

첨부 파일

NetworkAttachment

in/Out

 

6.147.2. GET나열

호스트 또는 호스트 NIC의 네트워크 연결 목록을 반환합니다.

네트워크 첨부 파일의 반환 목록 순서는 보장되지 않습니다.

Expand
표 6.447. 매개변수 요약
이름유형방향요약

첨부 파일

NetworkAttachment[]

Out

 

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 최대 첨부 파일 수를 설정합니다.

6.147.2.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.147.2.2. max

반환할 최대 첨부 파일 수를 설정합니다. 지정하지 않으면 모든 첨부 파일이 반환됩니다.

6.148. NetworkFilter

네트워크 필터를 관리합니다.

<network_filter id="00000019-0019-0019-0019-00000000026b">
  <name>example-network-filter-b</name>
  <version>
    <major>4</major>
    <minor>0</minor>
    <build>-1</build>
    <revision>-1</revision>
  </version>
</network_filter>

버전은 특정 필터에 대한 최소 지원 버전을 참조합니다.

Expand
표 6.448. 메서드 요약
이름요약

get

네트워크 필터의 표현을 검색합니다.

6.148.1. GET가져오기

네트워크 필터의 표현을 검색합니다.

Expand
표 6.449. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

network_filter

NetworkFilter

Out

 
6.148.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.149. NetworkFilters

하위 수집 전용 네트워크 필터를 나타냅니다.

네트워크 필터를 사용하면 정의된 규칙에 따라 VM의 NIC로 전송된 패킷을 필터링할 수 있습니다. 자세한 내용은 NetworkFilter 서비스 설명서를 참조하십시오.

네트워크 필터는 버전 3.0부터 다양한 버전에서 지원됩니다.

네트워크 필터는 각 vnic 프로필에 대해 정의됩니다.

vnic 프로필은 특정 네트워크에 대해 정의됩니다.

하나의 네트워크는 여러 다른 클러스터에 할당할 수 있습니다. 향후 각 네트워크는 클러스터 수준에서 정의됩니다.

현재 각 네트워크는 데이터 센터 수준에서 정의되고 있습니다. 각 네트워크에 대한 잠재적인 네트워크 필터는 네트워크의 데이터 센터 호환성 버전 V에 의해 결정됩니다. V는 특정 네트워크에 대한 네트워크 필터를 구성하기 위해 네트워크 필터 버전 >= the network filter version이어야 합니다. 네트워크 필터를 지원하는 버전이 있는 클러스터에 네트워크가 할당된 경우 데이터 센터 버전이 작기 때문에 필터를 사용할 수 없는 경우 네트워크 필터의 버전에 따라 필터를 사용할 수 없습니다.

특정 클러스터에 대해 지원되는 모든 네트워크 필터를 나열하는 예:

GET http://localhost:8080/ovirt-engine/api/clusters/{cluster:id}/networkfilters

출력:

<network_filters>
  <network_filter id="00000019-0019-0019-0019-00000000026c">
    <name>example-network-filter-a</name>
    <version>
      <major>4</major>
      <minor>0</minor>
      <build>-1</build>
      <revision>-1</revision>
    </version>
  </network_filter>
  <network_filter id="00000019-0019-0019-0019-00000000026b">
    <name>example-network-filter-b</name>
    <version>
      <major>4</major>
      <minor>0</minor>
      <build>-1</build>
      <revision>-1</revision>
    </version>
  </network_filter>
  <network_filter id="00000019-0019-0019-0019-00000000026a">
    <name>example-network-filter-a</name>
    <version>
      <major>3</major>
      <minor>0</minor>
      <build>-1</build>
      <revision>-1</revision>
    </version>
  </network_filter>
</network_filters>
Expand
표 6.450. 메서드 요약
이름요약

list

네트워크 필터의 표현을 검색합니다.

6.149.1. GET나열

네트워크 필터의 표현을 검색합니다.

반환된 네트워크 필터 목록의 순서는 보장되지 않습니다.

Expand
표 6.451. 매개변수 요약
이름유형방향요약

필터

NetworkFilter[]

Out

 

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

6.149.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.150. NetworkLabel

Expand
표 6.452. 메서드 요약
이름요약

get

 

제거

논리적 네트워크에서 레이블을 제거합니다.

6.150.1. GET가져오기

Expand
표 6.453. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

label

NetworkLabel

Out

 
6.150.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.150.2. DELETE제거

논리적 네트워크에서 레이블을 제거합니다.

예를 들어 ID 123 이 있는 논리적 네트워크에서 예시적인 레이블을 제거하려면 다음 요청을 보냅니다.

DELETE /ovirt-engine/api/networks/123/networklabels/exemplary
Expand
표 6.454. 매개변수 요약
이름유형방향요약

async

부울

in

제거가 비동기적으로 수행되어야 하는지 여부를 나타냅니다.

6.151. NetworkLabels

네트워크 또는 호스트 NIC에 연결된 레이블의 수를 관리합니다.

Expand
표 6.455. 메서드 요약
이름요약

add

논리적 네트워크에 레이블을 연결합니다.

list

네트워크 또는 호스트 NIC에 연결된 라벨 목록을 반환합니다.

6.151.1. POST추가

논리적 네트워크에 레이블을 연결합니다.

레이블을 논리적 네트워크에 연결하여 동일한 레이블이 연결된 물리적 호스트 네트워크 인터페이스를 사용하여 해당 논리적 네트워크의 연결을 자동화할 수 있습니다.

예를 들어 mylabel 레이블을 id 123 이 있는 논리 네트워크에 연결하려면 다음과 같은 요청을 보냅니다.

POST /ovirt-engine/api/networks/123/networklabels

다음과 같이 요청 본문이 있는 경우:

<network_label id="mylabel"/>
Expand
표 6.456. 매개변수 요약
이름유형방향요약

label

NetworkLabel

in/Out

 

6.151.2. GET나열

네트워크 또는 호스트 NIC에 연결된 라벨 목록을 반환합니다.

반환된 라벨 목록의 순서는 보장되지 않습니다.

Expand
표 6.457. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

labels

NetworkLabel[]

Out

 

max

정수

in

반환할 최대 레이블 수를 설정합니다.

6.151.2.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.151.2.2. max

반환할 최대 레이블 수를 설정합니다. 지정하지 않으면 모든 라벨이 반환됩니다.

6.152. 네트워크

논리적 네트워크를 관리합니다.

이 엔진은 설치에 기본 trusted CA 네트워크를 생성합니다. 이 네트워크는 하이퍼바이저 호스트에 액세스하기 위한 관리 네트워크 역할을 합니다. 이 네트워크는 Default 클러스터와 연결되며 Default 데이터 센터의 멤버입니다.

Expand
표 6.458. 메서드 요약
이름요약

add

새 논리적 네트워크를 생성하거나 기존 네트워크를 데이터 센터와 연결합니다.

list

논리적 네트워크를 나열합니다.

6.152.1. POST추가

새 논리적 네트워크를 생성하거나 기존 네트워크를 데이터 센터와 연결합니다.

새 네트워크를 만들려면 namedata_center 요소가 필요합니다.

예를 들어 데이터 센터( 123 )에 대해 mynetwork 라는 네트워크를 생성하려면 다음과 같은 요청을 보냅니다.

POST /ovirt-engine/api/networks

다음과 같이 요청 본문이 있는 경우:

<network>
  <name>mynetwork</name>
  <data_center id="123"/>
</network>

기존 네트워크( 456 )를 데이터 센터( 123 )와 연관시키려면 다음과 같은 요청을 보내주세요.

POST /ovirt-engine/api/datacenters/123/networks

다음과 같이 요청 본문이 있는 경우:

<network>
  <name>ovirtmgmt</name>
</network>

외부 OpenStack 네트워크 공급자 456 위에 exnetwork 라는 네트워크를 생성하려면 다음과 같은 요청을 보냅니다.

POST /ovirt-engine/api/networks
<network>
  <name>exnetwork</name>
  <external_provider id="456"/>
  <data_center id="123"/>
</network>
Expand
표 6.459. 매개변수 요약
이름유형방향요약

network

네트워크

in/Out

 

6.152.2. GET나열

논리적 네트워크를 나열합니다.

예를 들어 다음과 같습니다.

GET /ovirt-engine/api/networks

응답일 것입니다:

<networks>
  <network href="/ovirt-engine/api/networks/123" id="123">
    <name>ovirtmgmt</name>
    <description>Default Management Network</description>
    <link href="/ovirt-engine/api/networks/123/permissions" rel="permissions"/>
    <link href="/ovirt-engine/api/networks/123/vnicprofiles" rel="vnicprofiles"/>
    <link href="/ovirt-engine/api/networks/123/networklabels" rel="networklabels"/>
    <mtu>0</mtu>
    <stp>false</stp>
    <usages>
      <usage>vm</usage>
    </usages>
    <data_center href="/ovirt-engine/api/datacenters/456" id="456"/>
  </network>
  ...
</networks>

반환된 네트워크 목록의 순서는 sortby 절이 검색 매개변수에 포함된 경우에만 보장됩니다.

Expand
표 6.460. 매개변수 요약
이름유형방향요약

case_sensitive

부울

in

검색 매개 변수를 사용하여 수행된 검색이 대소문자를 고려하여 수행해야 하는지 여부를 나타냅니다.

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 최대 네트워크 수를 설정합니다.

networks

Network[]

Out

 

search

문자열

in

반환된 네트워크를 제한하는 데 사용되는 쿼리 문자열입니다.

6.152.2.1. case_sensitive

검색 매개 변수를 사용하여 수행된 검색이 대소문자를 고려하여 수행해야 하는지 여부를 나타냅니다. 기본값은 true 입니다. 즉, 해당 케이스가 고려됩니다. 대소문자를 무시하고자 하는 경우 false 로 설정합니다.

6.152.2.2. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.152.2.3. max

반환할 최대 네트워크 수를 설정합니다. 지정하지 않으면 모든 네트워크가 반환됩니다.

6.153. NicNetworkFilterParameter

이 서비스는 네트워크 필터의 매개 변수를 관리합니다.

Expand
표 6.461. 메서드 요약
이름요약

get

network filter 매개변수의 표현을 검색합니다.

제거

filter 매개변수를 제거합니다.

update

network filter 매개변수를 업데이트합니다.

6.153.1. GET가져오기

network filter 매개변수의 표현을 검색합니다.

Expand
표 6.462. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

매개변수

NetworkFilterParameter

Out

네트워크 필터 매개 변수의 표현입니다.

6.153.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.153.2. DELETE제거

filter 매개변수를 제거합니다.

예를 들어 NIC 456 에서 id가 123 인 filter 매개변수를 제거하려면 다음과 같은 요청을 보냅니다.

DELETE /ovirt-engine/api/vms/789/nics/456/networkfilterparameters/123

6.153.3. PUT업데이트

network filter 매개변수를 업데이트합니다.

예를 들어 NIC 456 에서 id 123 이 있는 네트워크 필터 매개변수를 업데이트하려면 다음과 같은 요청을 보냅니다.

PUT /ovirt-engine/api/vms/789/nics/456/networkfilterparameters/123

다음과 같이 요청 본문이 있는 경우:

<network_filter_parameter>
  <name>updatedName</name>
  <value>updatedValue</value>
</network_filter_parameter>
Expand
표 6.463. 매개변수 요약
이름유형방향요약

매개변수

NetworkFilterParameter

in/Out

업데이트 중인 network filter 매개변수입니다.

6.154. NicNetworkFilterParameters

이 서비스는 네트워크 필터에 대한 매개변수 컬렉션을 관리합니다.

Expand
표 6.464. 메서드 요약
이름요약

add

네트워크 필터 매개 변수를 추가합니다.

list

network filter 매개변수의 표현을 검색합니다.

6.154.1. POST추가

네트워크 필터 매개 변수를 추가합니다.

예를 들어 가상 머신(809)의 NIC 456 에 네트워크 필터에 대한 매개변수를 추가하려면 다음과 같은 요청을 보냅니다.

POST /ovirt-engine/api/vms/789/nics/456/networkfilterparameters

다음과 같이 요청 본문이 있는 경우:

<network_filter_parameter>
  <name>IP</name>
  <value>10.0.1.2</value>
</network_filter_parameter>
Expand
표 6.465. 매개변수 요약
이름유형방향요약

매개변수

NetworkFilterParameter

in/Out

추가 중인 네트워크 필터 매개 변수입니다.

6.154.2. GET나열

network filter 매개변수의 표현을 검색합니다.

반환된 네트워크 필터 목록의 순서는 보장되지 않습니다.

Expand
표 6.466. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

parameters

NetworkFilterParameter[]

Out

네트워크 필터 매개변수 목록입니다.

6.154.2.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.155. OpenstackImage

Expand
표 6.467. 메서드 요약
이름요약

get

 

import

Glance 이미지 스토리지 도메인에서 가상 머신을 가져옵니다.

6.155.1. GET가져오기

Expand
표 6.468. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

image

OpenStackImage

Out

 
6.155.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.155.2. POST가져오기

Glance 이미지 스토리지 도메인에서 가상 머신을 가져옵니다.

예를 들어 식별자가 123 인 스토리지 도메인에서 식별자 456 이 있는 이미지를 가져오려면 다음과 같이 요청을 보냅니다.

POST /ovirt-engine/api/openstackimageproviders/123/images/456/import

다음과 같이 요청 본문이 있는 경우:

<action>
  <storage_domain>
    <name>images0</name>
  </storage_domain>
  <cluster>
    <name>images0</name>
  </cluster>
</action>
Expand
표 6.469. 매개변수 요약
이름유형방향요약

async

부울

in

비동기적으로 가져오기를 수행해야 하는지 여부를 나타냅니다.Indicates if the import should be performed asynchronously.

cluster

Cluster

in

이 매개변수는 import_as_template 을 사용하는 경우 필수이며 Glance 이미지를 템플릿으로 가져와야 하는 클러스터를 나타냅니다.

disk

디스크

in

 

import_as_template

부울

in

이미지를 템플릿으로 가져올지 여부를 나타냅니다.

storage_domain

StorageDomain

in

 

template

템플릿

in

 

6.156. OpenstackImageProvider

Expand
표 6.470. 메서드 요약
이름요약

get

 

importcertificates

외부 호스트 공급자의 SSL 인증서를 가져옵니다.

제거

 

testconnectivity

외부 공급자에 대한 연결을 테스트하려면 123이 공급자의 ID인 다음 요청을 실행해야 합니다.

update

시스템에서 지정된 OpenStack 이미지 공급자를 업데이트합니다.

6.156.1. GET가져오기

Expand
표 6.471. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

provider

OpenStackImageProvider

Out

 
6.156.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.156.2. importcertificates POST

외부 호스트 공급자의 SSL 인증서를 가져옵니다.

Expand
표 6.472. 매개변수 요약
이름유형방향요약

인증서

인증서 []

in

 

6.156.3. DELETE제거

Expand
표 6.473. 매개변수 요약
이름유형방향요약

async

부울

in

제거가 비동기적으로 수행되어야 하는지 여부를 나타냅니다.

6.156.4. testconnectivity POST

외부 공급자에 대한 연결을 테스트하려면 123이 공급자의 ID인 다음 요청을 실행해야 합니다.

POST /ovirt-engine/api/externalhostproviders/123/testconnectivity
Expand
표 6.474. 매개변수 요약
이름유형방향요약

async

부울

in

테스트를 비동기적으로 수행해야 하는지 여부를 나타냅니다.Indicates if the test should be performed asynchronously.

6.156.5. PUT업데이트

시스템에서 지정된 OpenStack 이미지 공급자를 업데이트합니다.

Expand
표 6.475. 매개변수 요약
이름유형방향요약

async

부울

in

업데이트를 비동기적으로 수행해야 하는지 여부를 나타냅니다.

provider

OpenStackImageProvider

in/Out

 

6.157. OpenstackImageProviders

Expand
표 6.476. 메서드 요약
이름요약

add

새 OpenStack 이미지 공급자를 시스템에 추가합니다.

list

공급자 목록을 반환합니다.

6.157.1. POST추가

새 OpenStack 이미지 공급자를 시스템에 추가합니다.

Expand
표 6.477. 매개변수 요약
이름유형방향요약

provider

OpenStackImageProvider

in/Out

 

6.157.2. GET나열

공급자 목록을 반환합니다.

반환된 공급자 목록의 순서는 보장되지 않습니다.

Expand
표 6.478. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 최대 공급자 수를 설정합니다.

providers

OpenStackImageProvider[]

Out

 

search

문자열

in

반환된 OpenStack 이미지 공급자를 제한하는 데 사용되는 쿼리 문자열입니다.

6.157.2.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.157.2.2. max

반환할 최대 공급자 수를 설정합니다. 지정하지 않으면 모든 공급자가 반환됩니다.

6.158. OpenstackImages

Expand
표 6.479. 메서드 요약
이름요약

list

Glance 이미지 스토리지 도메인의 이미지를 나열합니다.

6.158.1. GET나열

Glance 이미지 스토리지 도메인의 이미지를 나열합니다.

반환된 이미지 목록의 순서는 보장되지 않습니다.

Expand
표 6.480. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

images

OpenStackImage[]

Out

 

max

정수

in

반환할 최대 이미지 수를 설정합니다.

6.158.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.158.1.2. max

반환할 최대 이미지 수를 설정합니다. 지정하지 않으면 모든 이미지가 반환됩니다.

6.159. OpenstackNetwork

Expand
표 6.481. 메서드 요약
이름요약

get

 

import

이 작업은 외부 네트워크를 Red Hat Virtualization에 가져옵니다.

6.159.1. GET가져오기

Expand
표 6.482. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

network

OpenStackNetwork

Out

 
6.159.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.159.2. POST가져오기

이 작업은 외부 네트워크를 Red Hat Virtualization에 가져옵니다. 네트워크가 지정된 데이터 센터에 추가됩니다.

Expand
표 6.483. 매개변수 요약
이름유형방향요약

async

부울

in

비동기적으로 가져오기를 수행해야 하는지 여부를 나타냅니다.Indicates if the import should be performed asynchronously.

data_center

DataCenter

in

네트워크를 가져올 데이터 센터입니다.

6.159.2.1. data_center

네트워크를 가져올 데이터 센터입니다. 데이터 센터는 필수이며 id 또는 name 속성을 사용하여 지정할 수 있습니다. 나머지 속성은 무시됩니다.

참고

공급자에 auto_sync 가 활성화된 경우 네트워크를 자동으로 가져올 수 있습니다. 이를 방지하기 위해 auto_sync 를 false로 설정하고 네트워크를 가져온 후 다시 활성화하여 자동 가져오기를 비활성화할 수 있습니다.

6.160. OpenstackNetworkProvider

이 서비스는 OpenStack 네트워크 공급자를 관리합니다.

Expand
표 6.484. 메서드 요약
이름요약

get

이 서비스에서 관리하는 오브젝트의 표현을 반환합니다.

importcertificates

외부 호스트 공급자의 SSL 인증서를 가져옵니다.

제거

공급자를 제거합니다.

testconnectivity

외부 공급자에 대한 연결을 테스트하려면 123이 공급자의 ID인 다음 요청을 실행해야 합니다.

update

공급자를 업데이트합니다.

6.160.1. GET가져오기

이 서비스에서 관리하는 오브젝트의 표현을 반환합니다.

예를 들어 식별자 1234 가 있는 OpenStack 네트워크 공급자를 가져오려면 다음과 같은 요청을 보냅니다.

GET /ovirt-engine/api/openstacknetworkproviders/1234
Expand
표 6.485. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

provider

OpenStackNetworkProvider

Out

 
6.160.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.160.2. importcertificates POST

외부 호스트 공급자의 SSL 인증서를 가져옵니다.

Expand
표 6.486. 매개변수 요약
이름유형방향요약

인증서

인증서 []

in

 

6.160.3. DELETE제거

공급자를 제거합니다.

예를 들어 식별자 1234 가 있는 OpenStack 네트워크 공급자를 제거하려면 다음과 같은 요청을 보냅니다.

DELETE /ovirt-engine/api/openstacknetworkproviders/1234
Expand
표 6.487. 매개변수 요약
이름유형방향요약

async

부울

in

제거가 비동기적으로 수행되어야 하는지 여부를 나타냅니다.

6.160.4. testconnectivity POST

외부 공급자에 대한 연결을 테스트하려면 123이 공급자의 ID인 다음 요청을 실행해야 합니다.

POST /ovirt-engine/api/externalhostproviders/123/testconnectivity
Expand
표 6.488. 매개변수 요약
이름유형방향요약

async

부울

in

테스트를 비동기적으로 수행해야 하는지 여부를 나타냅니다.Indicates if the test should be performed asynchronously.

6.160.5. PUT업데이트

공급자를 업데이트합니다.

예를 들어 provider_name,requires_authentication,url,tenant_nametype 속성을 업데이트하려면 식별자 1234 를 갖는 OpenStack 네트워크 공급자의 경우 다음과 같은 요청을 보냅니다.

PUT /ovirt-engine/api/openstacknetworkproviders/1234

다음과 같이 요청 본문이 있는 경우:

<openstack_network_provider>
  <name>ovn-network-provider</name>
  <requires_authentication>false</requires_authentication>
  <url>http://some_server_url.domain.com:9696</url>
  <tenant_name>oVirt</tenant_name>
  <type>external</type>
</openstack_network_provider>
Expand
표 6.489. 매개변수 요약
이름유형방향요약

async

부울

in

업데이트를 비동기적으로 수행해야 하는지 여부를 나타냅니다.

provider

OpenStackNetworkProvider

in/Out

업데이트할 공급자입니다.

6.161. OpenstackNetworkProviders

이 서비스는 OpenStack 네트워크 공급자를 관리합니다.

Expand
표 6.490. 메서드 요약
이름요약

add

이 작업은 시스템에 새 네트워크 공급자를 추가합니다.

list

공급자 목록을 반환합니다.

6.161.1. POST추가

이 작업은 시스템에 새 네트워크 공급자를 추가합니다. type 속성이 없으면 NEUTRON 의 기본값이 사용됩니다.

Expand
표 6.491. 매개변수 요약
이름유형방향요약

provider

OpenStackNetworkProvider

in/Out

 

6.161.2. GET나열

공급자 목록을 반환합니다.

반환된 공급자 목록의 순서는 보장되지 않습니다.

Expand
표 6.492. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 최대 공급자 수를 설정합니다.

providers

OpenStackNetworkProvider[]

Out

 

search

문자열

in

반환된 OpenStack 네트워크 공급자를 제한하는 데 사용되는 쿼리 문자열입니다.

6.161.2.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.161.2.2. max

반환할 최대 공급자 수를 설정합니다. 지정하지 않으면 모든 공급자가 반환됩니다.

6.162. OpenstackNetworks

Expand
표 6.493. 메서드 요약
이름요약

list

네트워크 목록을 반환합니다.

6.162.1. GET나열

네트워크 목록을 반환합니다.

반환된 네트워크 목록의 순서는 보장되지 않습니다.

Expand
표 6.494. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 최대 네트워크 수를 설정합니다.

networks

OpenStackNetwork[]

Out

 
6.162.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.162.1.2. max

반환할 최대 네트워크 수를 설정합니다. 지정하지 않으면 모든 네트워크가 반환됩니다.

6.163. OpenstackSubnet

Expand
표 6.495. 메서드 요약
이름요약

get

 

제거

 

6.163.1. GET가져오기

Expand
표 6.496. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

서브넷

OpenStackSubnet

Out

 
6.163.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.163.2. DELETE제거

Expand
표 6.497. 매개변수 요약
이름유형방향요약

async

부울

in

제거가 비동기적으로 수행되어야 하는지 여부를 나타냅니다.

6.164. OpenstackSubnets

Expand
표 6.498. 메서드 요약
이름요약

add

 

list

하위 네트워크 목록을 반환합니다.

6.164.1. POST추가

Expand
표 6.499. 매개변수 요약
이름유형방향요약

서브넷

OpenStackSubnet

in/Out

 

6.164.2. GET나열

하위 네트워크 목록을 반환합니다.

반환된 하위 네트워크 목록의 순서가 보장되지 않습니다.

Expand
표 6.500. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 최대 하위 네트워크 수를 설정합니다.

subnets

OpenStackSubnet[]

Out

 
6.164.2.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.164.2.2. max

반환할 최대 하위 네트워크 수를 설정합니다. 지정하지 않으면 모든 하위 네트워크가 반환됩니다.

6.165. OpenstackVolumeAuthenticationKey

OpenStack Volume(Cinder) 통합이 Managed Block Storage로 교체되었습니다.

Expand
표 6.501. 메서드 요약
이름요약

get

 

제거

 

update

지정된 인증 키를 업데이트합니다.

6.165.1. GET가져오기

Expand
표 6.502. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

key

OpenstackVolumeAuthenticationKey

Out

 
6.165.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.165.2. DELETE제거

Expand
표 6.503. 매개변수 요약
이름유형방향요약

async

부울

in

제거가 비동기적으로 수행되어야 하는지 여부를 나타냅니다.

6.165.3. PUT업데이트

지정된 인증 키를 업데이트합니다.

Expand
표 6.504. 매개변수 요약
이름유형방향요약

key

OpenstackVolumeAuthenticationKey

in/Out

 

6.166. OpenstackVolumeAuthenticationKeys

OpenStack Volume(Cinder) 통합이 Managed Block Storage로 교체되었습니다.

Expand
표 6.505. 메서드 요약
이름요약

add

OpenStack 볼륨 공급자에 새 인증 키를 추가합니다.

list

인증 키 목록을 반환합니다.

6.166.1. POST추가

OpenStack 볼륨 공급자에 새 인증 키를 추가합니다.

Expand
표 6.506. 매개변수 요약
이름유형방향요약

key

OpenstackVolumeAuthenticationKey

in/Out

 

6.166.2. GET나열

인증 키 목록을 반환합니다.

반환된 인증 키 목록의 순서는 보장되지 않습니다.

Expand
표 6.507. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

keys

OpenstackVolumeAuthenticationKey[]

Out

 

max

정수

in

반환할 최대 키 수를 설정합니다.

6.166.2.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.166.2.2. max

반환할 최대 키 수를 설정합니다. 지정하지 않으면 모든 키가 반환됩니다.

6.167. OpenstackVolumeProvider

OpenStack Volume(Cinder) 통합이 Managed Block Storage로 교체되었습니다.

Expand
표 6.508. 메서드 요약
이름요약

get

 

importcertificates

외부 호스트 공급자의 SSL 인증서를 가져옵니다.

제거

 

testconnectivity

외부 공급자에 대한 연결을 테스트하려면 123이 공급자의 ID인 다음 요청을 실행해야 합니다.

update

시스템에서 지정된 OpenStack 볼륨 공급자를 업데이트합니다.

6.167.1. GET가져오기

Expand
표 6.509. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

provider

OpenStackVolumeProvider

Out

 
6.167.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.167.2. importcertificates POST

외부 호스트 공급자의 SSL 인증서를 가져옵니다.

Expand
표 6.510. 매개변수 요약
이름유형방향요약

인증서

인증서 []

in

 

6.167.3. DELETE제거

Expand
표 6.511. 매개변수 요약
이름유형방향요약

async

부울

in

제거가 비동기적으로 수행되어야 하는지 여부를 나타냅니다.

force

부울

in

작업이 성공해야 하는지, 작업 중에 문제가 발생한 경우에도 데이터베이스에서 제거된 공급자를 나타냅니다.Indicates if the operation should succeed, and the provider removed from the database, even if something fails during the operation.

6.167.3.1. force

작업이 성공해야 하는지, 작업 중에 문제가 발생한 경우에도 데이터베이스에서 제거된 공급자를 나타냅니다.Indicates if the operation should succeed, and the provider removed from the database, even if something fails during the operation.

이 매개변수는 선택 사항이며 기본값은 false 입니다.

6.167.4. testconnectivity POST

외부 공급자에 대한 연결을 테스트하려면 123이 공급자의 ID인 다음 요청을 실행해야 합니다.

POST /ovirt-engine/api/externalhostproviders/123/testconnectivity
Expand
표 6.512. 매개변수 요약
이름유형방향요약

async

부울

in

테스트를 비동기적으로 수행해야 하는지 여부를 나타냅니다.Indicates if the test should be performed asynchronously.

6.167.5. PUT업데이트

시스템에서 지정된 OpenStack 볼륨 공급자를 업데이트합니다.

Expand
표 6.513. 매개변수 요약
이름유형방향요약

async

부울

in

업데이트를 비동기적으로 수행해야 하는지 여부를 나타냅니다.

provider

OpenStackVolumeProvider

in/Out

 

6.168. OpenstackVolumeProviders

OpenStack Volume(Cinder) 통합이 Managed Block Storage로 교체되었습니다.

Expand
표 6.514. 메서드 요약
이름요약

add

새 볼륨 공급자를 추가합니다.

list

볼륨 공급자 목록을 검색합니다.

6.168.1. POST추가

새 볼륨 공급자를 추가합니다.

예를 들어 다음과 같습니다.

POST /ovirt-engine/api/openstackvolumeproviders

다음과 같이 요청 본문이 있는 경우:

<openstack_volume_provider>
  <name>mycinder</name>
  <url>https://mycinder.example.com:8776</url>
  <data_center>
    <name>mydc</name>
  </data_center>
  <requires_authentication>true</requires_authentication>
  <username>admin</username>
  <password>mypassword</password>
  <tenant_name>mytenant</tenant_name>
</openstack_volume_provider>
Expand
표 6.515. 매개변수 요약
이름유형방향요약

provider

OpenStackVolumeProvider

in/Out

 

6.168.2. GET나열

볼륨 공급자 목록을 검색합니다.

반환된 볼륨 공급자 목록의 순서는 보장되지 않습니다.

Expand
표 6.516. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 최대 공급자 수를 설정합니다.

providers

OpenStackVolumeProvider[]

Out

 

search

문자열

in

반환된 볼륨 공급자를 제한하는 데 사용되는 쿼리 문자열입니다.

6.168.2.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.168.2.2. max

반환할 최대 공급자 수를 설정합니다. 지정하지 않으면 모든 공급자가 반환됩니다.

6.169. OpenstackVolumeType

OpenStack Volume(Cinder) 통합이 Managed Block Storage로 교체되었습니다.

Expand
표 6.517. 메서드 요약
이름요약

get

 

6.169.1. GET가져오기

Expand
표 6.518. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

type

OpenStackVolumeType

Out

 
6.169.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.170. OpenstackVolumeTypes

OpenStack Volume(Cinder) 통합이 Managed Block Storage로 교체되었습니다.

Expand
표 6.519. 메서드 요약
이름요약

list

볼륨 유형 목록을 반환합니다.

6.170.1. GET나열

볼륨 유형 목록을 반환합니다.

반환된 볼륨 유형 목록의 순서는 보장되지 않습니다.

Expand
표 6.520. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 최대 볼륨 유형 수를 설정합니다.

유형

OpenStackVolumeType[]

Out

 
6.170.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.170.1.2. max

반환할 최대 볼륨 유형 수를 설정합니다. 지정하지 않으면 모든 볼륨 유형이 반환됩니다.

6.171. OperatingSystem

Expand
표 6.521. 메서드 요약
이름요약

get

 

6.171.1. GET가져오기

Expand
표 6.522. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

operating_system

OperatingSystemInfo

Out

 
6.171.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.172. OperatingSystems

시스템에서 사용 가능한 운영 체제 유형 집합을 관리합니다.

Expand
표 6.523. 메서드 요약
이름요약

list

시스템에서 사용 가능한 운영 체제 유형 목록을 반환합니다.

6.172.1. GET나열

시스템에서 사용 가능한 운영 체제 유형 목록을 반환합니다.

반환된 운영 체제 목록의 순서는 보장되지 않습니다.

Expand
표 6.524. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 최대 네트워크 수를 설정합니다.

operating_system

OperatingSystemInfo[]

Out

 
6.172.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.172.1.2. max

반환할 최대 네트워크 수를 설정합니다. 지정하지 않으면 모든 네트워크가 반환됩니다.

6.173. 권한

Expand
표 6.525. 메서드 요약
이름요약

get

 

제거

 

6.173.1. GET가져오기

Expand
표 6.526. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

권한

권한

Out

 
6.173.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.173.2. DELETE제거

Expand
표 6.527. 매개변수 요약
이름유형방향요약

async

부울

in

제거가 비동기적으로 수행되어야 하는지 여부를 나타냅니다.

6.174. 허용

역할의 특정 권한을 관리하는 서비스입니다.

Expand
표 6.528. 메서드 요약
이름요약

get

역할 허용에 대한 정보를 가져옵니다.Gets the information about the permission of the role.

제거

역할에서 권한을 제거합니다.

6.174.1. GET가져오기

역할 허용에 대한 정보를 가져옵니다.Gets the information about the permission of the role.

예를 들어 ID가 123 인 역할의 ID 456 으로 허용에 대한 정보를 검색하려면 다음과 같은 요청을 보냅니다.

GET /ovirt-engine/api/roles/123/permits/456
<permit href="/ovirt-engine/api/roles/123/permits/456" id="456">
  <name>change_vm_cd</name>
  <administrative>false</administrative>
  <role href="/ovirt-engine/api/roles/123" id="123"/>
</permit>
Expand
표 6.529. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

permit

허용

Out

역할의 허용입니다.

6.174.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.174.2. DELETE제거

역할에서 권한을 제거합니다.

예를 들어 ID 123 이 있는 역할에서 ID 456 의 허용을 제거하려면 다음과 같은 요청을 보냅니다.

DELETE /ovirt-engine/api/roles/123/permits/456
Expand
표 6.530. 매개변수 요약
이름유형방향요약

async

부울

in

제거가 비동기적으로 수행되어야 하는지 여부를 나타냅니다.

6.175. 허용

특정 역할의 허용 하위 컬렉션을 나타냅니다.Represents a permits sub-collection of the specific role.

Expand
표 6.531. 메서드 요약
이름요약

add

역할에 허용을 추가합니다.

list

역할의 권한을 나열합니다.

6.175.1. POST추가

역할에 허용을 추가합니다. 허용 이름은 cluster_levels 서비스에서 검색할 수 있습니다.

예를 들어 ID 123 이 다음과 같은 요청을 사용하여 권한 부여 create_vm 을 역할에 할당하려면 다음을 수행합니다.

POST /ovirt-engine/api/roles/123/permits

다음과 같이 요청 본문이 있는 경우:

<permit>
  <name>create_vm</name>
</permit>
Expand
표 6.532. 매개변수 요약
이름유형방향요약

permit

허용

in/Out

추가할 수 있도록 허용

6.175.2. GET나열

역할의 권한을 나열합니다.

예를 들어 ID 123 으로 역할 허용을 나열하려면 다음과 같은 요청을 보냅니다.

GET /ovirt-engine/api/roles/123/permits
<permits>
  <permit href="/ovirt-engine/api/roles/123/permits/5" id="5">
    <name>change_vm_cd</name>
    <administrative>false</administrative>
    <role href="/ovirt-engine/api/roles/123" id="123"/>
  </permit>
  <permit href="/ovirt-engine/api/roles/123/permits/7" id="7">
    <name>connect_to_vm</name>
    <administrative>false</administrative>
    <role href="/ovirt-engine/api/roles/123" id="123"/>
  </permit>
</permits>

반환 된 허용 목록의 순서가 보장되지 않습니다.

Expand
표 6.533. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 수 있는 최대 허용 수를 설정합니다.

허용

허가 []

Out

허용 목록입니다.

6.175.2.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.175.2.2. max

반환할 수 있는 최대 허용 수를 설정합니다. 지정하지 않으면 모든 허용이 반환됩니다.

6.176. QoS

Expand
표 6.534. 메서드 요약
이름요약

get

데이터 센터에서 지정된 QoS를 가져옵니다.

제거

데이터 센터에서 지정된 QoS를 제거합니다.

update

dataCenter에서 지정된 QoS를 업데이트합니다.

6.176.1. GET가져오기

데이터 센터에서 지정된 QoS를 가져옵니다.

GET /ovirt-engine/api/datacenters/123/qoss/123

다음과 같은 응답을 받을 수 있습니다.

<qos href="/ovirt-engine/api/datacenters/123/qoss/123" id="123">
  <name>123</name>
  <description>123</description>
  <max_iops>1</max_iops>
  <max_throughput>1</max_throughput>
  <type>storage</type>
  <data_center href="/ovirt-engine/api/datacenters/123" id="123"/>
</qos>
Expand
표 6.535. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

QoS

QoS

Out

QoS 오브젝트 쿼리.

6.176.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.176.2. DELETE제거

데이터 센터에서 지정된 QoS를 제거합니다.

DELETE /ovirt-engine/api/datacenters/123/qoss/123
Expand
표 6.536. 매개변수 요약
이름유형방향요약

async

부울

in

제거가 비동기적으로 수행되어야 하는지 여부를 나타냅니다.

6.176.3. PUT업데이트

dataCenter에서 지정된 QoS를 업데이트합니다.

PUT /ovirt-engine/api/datacenters/123/qoss/123

예를 들어 curl은 다음과 같습니다.

curl -u admin@internal:123456 -X PUT -H "content-type: application/xml" -d \
"<qos><name>321</name><description>321</description><max_iops>10</max_iops></qos>" \
https://engine/ovirt-engine/api/datacenters/123/qoss/123

다음과 같은 응답을 받게 됩니다.

<qos href="/ovirt-engine/api/datacenters/123/qoss/123" id="123">
  <name>321</name>
  <description>321</description>
  <max_iops>10</max_iops>
  <max_throughput>1</max_throughput>
  <type>storage</type>
  <data_center href="/ovirt-engine/api/datacenters/123" id="123"/>
</qos>
Expand
표 6.537. 매개변수 요약
이름유형방향요약

async

부울

in

업데이트를 비동기적으로 수행해야 하는지 여부를 나타냅니다.

QoS

QoS

in/Out

업데이트된 QoS 오브젝트입니다.

6.177. Qoss

데이터 센터에서 사용할 수 있는 서비스 품질 구성 세트를 관리합니다.

Expand
표 6.538. 메서드 요약
이름요약

add

dataCenter에 새 QoS를 추가합니다.

list

데이터 센터에서 사용 가능한 서비스 구성 품질 목록을 반환합니다.

6.177.1. POST추가

dataCenter에 새 QoS를 추가합니다.

POST /ovirt-engine/api/datacenters/123/qoss

응답은 다음과 같습니다.

<qos href="/ovirt-engine/api/datacenters/123/qoss/123" id="123">
  <name>123</name>
  <description>123</description>
  <max_iops>10</max_iops>
  <type>storage</type>
  <data_center href="/ovirt-engine/api/datacenters/123" id="123"/>
</qos>
Expand
표 6.539. 매개변수 요약
이름유형방향요약

QoS

QoS

in/Out

QoS 오브젝트를 추가했습니다.

6.177.2. GET나열

데이터 센터에서 사용 가능한 서비스 구성 품질 목록을 반환합니다.

GET /ovirt-engine/api/datacenter/123/qoss

다음과 같은 응답이 표시됩니다.

<qoss>
  <qos href="/ovirt-engine/api/datacenters/123/qoss/1" id="1">...</qos>
  <qos href="/ovirt-engine/api/datacenters/123/qoss/2" id="2">...</qos>
  <qos href="/ovirt-engine/api/datacenters/123/qoss/3" id="3">...</qos>
</qoss>

반환된 서비스 구성 목록은 보장되지 않습니다.

Expand
표 6.540. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 QoS 설명자의 최대 수를 설정합니다.

qoss

Qos[]

Out

쿼리된 QoS 오브젝트 목록입니다.

6.177.2.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.177.2.2. max

반환할 QoS 설명자의 최대 수를 설정합니다. 지정하지 않으면 모든 설명자가 반환됩니다.

6.178. 할당량

Expand
표 6.541. 메서드 요약
이름요약

get

할당량을 검색합니다.

제거

할당량을 삭제합니다.

update

할당량 업데이트.

6.178.1. GET가져오기

할당량을 검색합니다.

할당량을 검색하는 예:

GET /ovirt-engine/api/datacenters/123/quotas/456
<quota id="456">
  <name>myquota</name>
  <description>My new quota for virtual machines</description>
  <cluster_hard_limit_pct>20</cluster_hard_limit_pct>
  <cluster_soft_limit_pct>80</cluster_soft_limit_pct>
  <storage_hard_limit_pct>20</storage_hard_limit_pct>
  <storage_soft_limit_pct>80</storage_soft_limit_pct>
</quota>
Expand
표 6.542. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

quota

할당량

Out

 
6.178.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.178.2. DELETE제거

할당량을 삭제합니다.

할당량 삭제 예:

DELETE /ovirt-engine/api/datacenters/123-456/quotas/654-321
-0472718ab224 HTTP/1.1
Accept: application/xml
Content-type: application/xml
Expand
표 6.543. 매개변수 요약
이름유형방향요약

async

부울

in

제거가 비동기적으로 수행되어야 하는지 여부를 나타냅니다.

6.178.3. PUT업데이트

할당량 업데이트.

할당량 업데이트 예:

PUT /ovirt-engine/api/datacenters/123/quotas/456
<quota>
  <cluster_hard_limit_pct>30</cluster_hard_limit_pct>
  <cluster_soft_limit_pct>70</cluster_soft_limit_pct>
  <storage_hard_limit_pct>20</storage_hard_limit_pct>
  <storage_soft_limit_pct>80</storage_soft_limit_pct>
</quota>
Expand
표 6.544. 매개변수 요약
이름유형방향요약

async

부울

in

업데이트를 비동기적으로 수행해야 하는지 여부를 나타냅니다.

quota

할당량

in/Out

 

6.179. QuotaClusterLimit

Expand
표 6.545. 메서드 요약
이름요약

get

 

제거

 

6.179.1. GET가져오기

Expand
표 6.546. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

limit

QuotaClusterLimit

Out

 
6.179.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.179.2. DELETE제거

Expand
표 6.547. 매개변수 요약
이름유형방향요약

async

부울

in

제거가 비동기적으로 수행되어야 하는지 여부를 나타냅니다.

6.180. QuotaClusterLimits

클러스터에 구성된 할당량 제한 세트를 관리합니다.

Expand
표 6.548. 메서드 요약
이름요약

add

지정된 할당량에 클러스터 제한을 추가합니다.

list

클러스터에 구성된 할당량 제한 세트를 반환합니다.

6.180.1. POST추가

지정된 할당량에 클러스터 제한을 추가합니다.

Expand
표 6.549. 매개변수 요약
이름유형방향요약

limit

QuotaClusterLimit

in/Out

 

6.180.2. GET나열

클러스터에 구성된 할당량 제한 세트를 반환합니다.

반환된 할당량 제한 목록은 보장되지 않습니다.

Expand
표 6.550. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

제한

QuotaClusterLimit[]

Out

 

max

정수

in

반환할 최대 제한 수를 설정합니다.

6.180.2.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.180.2.2. max

반환할 최대 제한 수를 설정합니다. 지정하지 않으면 모든 제한이 반환됩니다.

6.181. QuotaStorageLimit

Expand
표 6.551. 메서드 요약
이름요약

get

 

제거

 

6.181.1. GET가져오기

Expand
표 6.552. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

limit

QuotaStorageLimit

Out

 
6.181.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.181.2. DELETE제거

Expand
표 6.553. 매개변수 요약
이름유형방향요약

async

부울

in

업데이트를 비동기적으로 수행해야 하는지 여부를 나타냅니다.

6.182. QuotaStorageLimits

할당량에 대해 구성된 스토리지 제한 세트를 관리합니다.

Expand
표 6.554. 메서드 요약
이름요약

add

지정된 할당량에 스토리지 제한을 추가합니다.

list

할당량에 대해 구성된 스토리지 제한 목록을 반환합니다.

6.182.1. POST추가

지정된 할당량에 스토리지 제한을 추가합니다.

데이터 센터의 모든 스토리지 도메인에 대해 100GiB 스토리지 제한을 생성하려면 다음과 같은 요청을 보냅니다.

POST /ovirt-engine/api/datacenters/123/quotas/456/quotastoragelimits

다음과 같이 요청 본문이 있는 경우:

<quota_storage_limit>
  <limit>100</limit>
</quota_storage_limit>

ID가 000 인 스토리지 도메인에 대해 50GiB 스토리지 제한을 생성하려면 다음과 같은 요청을 보냅니다.

POST /ovirt-engine/api/datacenters/123/quotas/456/quotastoragelimits

다음과 같이 요청 본문이 있는 경우:

<quota_storage_limit>
  <limit>50</limit>
  <storage_domain id="000"/>
</quota_storage_limit>
Expand
표 6.555. 매개변수 요약
이름유형방향요약

limit

QuotaStorageLimit

in/Out

 

6.182.2. GET나열

할당량에 대해 구성된 스토리지 제한 목록을 반환합니다.

반환된 스토리지 제한 목록의 순서는 보장되지 않습니다.

Expand
표 6.556. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

제한

QuotaStorageLimit[]

Out

 

max

정수

in

반환할 최대 제한 수를 설정합니다.

6.182.2.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.182.2.2. max

반환할 최대 제한 수를 설정합니다. 지정하지 않으면 모든 제한이 반환됩니다.

6.183. 할당량

데이터 센터에 구성된 할당량 세트를 관리합니다.

Expand
표 6.557. 메서드 요약
이름요약

add

새 할당량을 생성합니다.

list

데이터 센터 할당량을 나열합니다.

6.183.1. POST추가

새 할당량을 생성합니다.

새 할당량 생성의 예:

POST /ovirt-engine/api/datacenters/123/quotas
<quota>
  <name>myquota</name>
  <description>My new quota for virtual machines</description>
</quota>
Expand
표 6.558. 매개변수 요약
이름유형방향요약

quota

할당량

in/Out

 

6.183.2. GET나열

데이터 센터 할당량을 나열합니다.

반환된 할당량 목록의 순서는 보장되지 않습니다.

Expand
표 6.559. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

최대 할당량 설명자 수를 반환합니다.

할당량

Quota[]

Out

 
6.183.2.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.183.2.2. max

최대 할당량 설명자 수를 반환합니다. 지정하지 않으면 모든 설명자가 반환됩니다.

6.184. Role

Expand
표 6.560. 메서드 요약
이름요약

get

역할을 가져옵니다.

제거

역할을 제거합니다.

update

역할을 업데이트합니다.

6.184.1. GET가져오기

역할을 가져옵니다.

GET /ovirt-engine/api/roles/123

다음과 같은 XML 응답이 제공됩니다.

<role id="123">
  <name>MyRole</name>
  <description>MyRole description</description>
  <link href="/ovirt-engine/api/roles/123/permits" rel="permits"/>
  <administrative>true</administrative>
  <mutable>false</mutable>
</role>
Expand
표 6.561. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

role

Role

Out

검색된 역할입니다.

6.184.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.184.2. DELETE제거

역할을 제거합니다.

ID를 알아야 하는 역할을 제거하려면 다음과 같이 요청을 보냅니다.

DELETE /ovirt-engine/api/roles/{role_id}
Expand
표 6.562. 매개변수 요약
이름유형방향요약

async

부울

in

제거가 비동기적으로 수행되어야 하는지 여부를 나타냅니다.

6.184.3. PUT업데이트

역할을 업데이트합니다. 역할이 생성된 후 이름,설명관리 속성을 업데이트할 수 있습니다. 이 끝점에서는 역할 권한을 관리하는 서비스를 사용할 수 있는 역할을 추가하거나 제거할 수 없습니다.

예를 들어 역할 이름,설명관리 속성을 업데이트하려면 다음과 같은 요청을 보냅니다.

PUT /ovirt-engine/api/roles/123

다음과 같이 요청 본문이 있는 경우:

<role>
  <name>MyNewRoleName</name>
  <description>My new description of the role</description>
  <administrative>true</administrative>
</group>
Expand
표 6.563. 매개변수 요약
이름유형방향요약

async

부울

in

업데이트를 비동기적으로 수행해야 하는지 여부를 나타냅니다.

role

Role

in/Out

역할 업데이트됨.

6.185. 역할

글로벌 역할 집합에 대한 읽기 전용 액세스 제공

Expand
표 6.564. 메서드 요약
이름요약

add

새 역할을 생성합니다.

list

역할 나열.

6.185.1. POST추가

새 역할을 생성합니다. 역할은 관리 또는 비관리자일 수 있으며 다른 권한을 가질 수 있습니다.

예를 들어 MyRole 비관리 역할을 추가하여 로그인하고 가상 머신을 생성할 수 있도록 하려면 다음과 같은 요청을 보냅니다(허용 ID를 전달해야 함).

POST /ovirt-engine/api/roles

다음과 같이 요청 본문이 있는 경우:

<role>
  <name>MyRole</name>
  <description>My custom role to create virtual machines</description>
  <administrative>false</administrative>
  <permits>
    <permit id="1"/>
    <permit id="1300"/>
  </permits>
</group>
Expand
표 6.565. 매개변수 요약
이름유형방향요약

role

Role

in/Out

추가할 역할입니다.

6.185.2. GET나열

역할 나열.

GET /ovirt-engine/api/roles

다음과 같은 XML로 응답을 받습니다.

<roles>
  <role id="123">
     <name>SuperUser</name>
     <description>Roles management administrator</description>
     <link href="/ovirt-engine/api/roles/123/permits" rel="permits"/>
     <administrative>true</administrative>
     <mutable>false</mutable>
  </role>
  ...
</roles>

반환된 역할 목록의 순서는 보장되지 않습니다.

Expand
표 6.566. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 최대 역할 수를 설정합니다.

역할

Role []

Out

검색된 역할 목록입니다.

6.185.2.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.185.2.2. max

반환할 최대 역할 수를 설정합니다. 지정하지 않으면 모든 역할이 반환됩니다.

6.186. SchedulingPolicies

시스템에서 사용 가능한 스케줄링 정책 세트를 관리합니다.

Expand
표 6.567. 메서드 요약
이름요약

add

시스템에 새 스케줄링 정책을 추가합니다.

list

시스템에서 사용 가능한 스케줄링 정책 목록을 반환합니다.

6.186.1. POST추가

시스템에 새 스케줄링 정책을 추가합니다.

Expand
표 6.568. 매개변수 요약
이름유형방향요약

policy

SchedulingPolicy

in/Out

 

6.186.2. GET나열

시스템에서 사용 가능한 스케줄링 정책 목록을 반환합니다.

반환된 스케줄링 정책 목록의 순서는 보장되지 않습니다.

Expand
표 6.569. 매개변수 요약
이름유형방향요약

filter

부울

in

사용자의 권한에 따라 결과를 필터링해야 하는지 여부를 나타냅니다.

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 최대 정책 수를 설정합니다.

정책

SchedulingPolicy[]

Out

 
6.186.2.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.186.2.2. max

반환할 최대 정책 수를 설정합니다. 지정하지 않으면 모든 정책이 반환됩니다.

6.187. SchedulingPolicy

Expand
표 6.570. 메서드 요약
이름요약

get

 

제거

 

update

시스템에서 지정된 사용자 정의 스케줄링 정책을 업데이트합니다.

6.187.1. GET가져오기

Expand
표 6.571. 매개변수 요약
이름유형방향요약

filter

부울

in

사용자의 권한에 따라 결과를 필터링해야 하는지 여부를 나타냅니다.

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

policy

SchedulingPolicy

Out

 
6.187.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.187.2. DELETE제거

Expand
표 6.572. 매개변수 요약
이름유형방향요약

async

부울

in

제거가 비동기적으로 수행되어야 하는지 여부를 나타냅니다.

6.187.3. PUT업데이트

시스템에서 지정된 사용자 정의 스케줄링 정책을 업데이트합니다.

Expand
표 6.573. 매개변수 요약
이름유형방향요약

async

부울

in

업데이트를 비동기적으로 수행해야 하는지 여부를 나타냅니다.

policy

SchedulingPolicy

in/Out

 

6.188. SchedulingPolicyUnit

Expand
표 6.574. 메서드 요약
이름요약

get

 

제거

 

6.188.1. GET가져오기

Expand
표 6.575. 매개변수 요약
이름유형방향요약

filter

부울

in

사용자의 권한에 따라 결과를 필터링해야 하는지 여부를 나타냅니다.

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

단위

SchedulingPolicyUnit

Out

 
6.188.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.188.2. DELETE제거

Expand
표 6.576. 매개변수 요약
이름유형방향요약

async

부울

in

제거가 비동기적으로 수행되어야 하는지 여부를 나타냅니다.

6.189. SchedulingPolicyUnits

시스템에서 사용할 수 있는 스케줄링 정책 단위 집합을 관리합니다.

Expand
표 6.577. 메서드 요약
이름요약

list

시스템에서 사용 가능한 스케줄링 정책 단위 목록을 반환합니다.

6.189.1. GET나열

시스템에서 사용 가능한 스케줄링 정책 단위 목록을 반환합니다.

반환된 스케줄링 정책 단위 목록의 순서는 보장되지 않습니다.

Expand
표 6.578. 매개변수 요약
이름유형방향요약

filter

부울

in

사용자의 권한에 따라 결과를 필터링해야 하는지 여부를 나타냅니다.

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 최대 정책 단위 수를 설정합니다.

단위

SchedulingPolicyUnit[]

Out

 
6.189.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.189.1.2. max

반환할 최대 정책 단위 수를 설정합니다. 지정하지 않으면 정책 장치가 모두 반환됩니다.

6.190. 스냅샷

Expand
표 6.579. 메서드 요약
이름요약

get

 

제거

 

복원

가상 머신 스냅샷을 복원합니다.

6.190.1. GET가져오기

Expand
표 6.580. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

snapshot

스냅샷

Out

 
6.190.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.190.2. DELETE제거

Expand
표 6.581. 매개변수 요약
이름유형방향요약

all_content

부울

in

응답에 가상 머신 스냅샷의 모든 속성을 포함해야 하는지 여부를 나타냅니다.

async

부울

in

제거가 비동기적으로 수행되어야 하는지 여부를 나타냅니다.

6.190.2.1. all_content

응답에 가상 머신 스냅샷의 모든 속성을 포함해야 하는지 여부를 나타냅니다.

기본적으로 initialization.configuration.data 속성은 제외됩니다.

예를 들어 ID 123 으로 가상 머신의 ID 456 으로 스냅샷의 전체 표시를 검색하려면 다음과 같이 요청을 보냅니다.

GET /ovirt-engine/api/vms/123/snapshots/456?all_content=true

6.190.3. POST복원

가상 머신 스냅샷을 복원합니다.

예를 들어 식별자가 123 인 가상 머신의 식별자 456 으로 스냅샷을 복원하려면 다음과 같이 요청을 보냅니다.

POST /ovirt-engine/api/vms/123/snapshots/456/restore

본문에 빈 작업이 있는 경우:

<action/>
참고

가상 머신을 실행하기 전에 커밋 작업이 완료되고 가상 머신이 다운되었는지 확인합니다.

Expand
표 6.582. 매개변수 요약
이름유형방향요약

async

부울

in

복원을 비동기적으로 수행해야 하는지 여부를 나타냅니다.Indicates if the restore should be performed asynchronously.

디스크

Disk[]

in

스냅샷 복원에 포함된 디스크를 지정합니다.

restore_memory

부울

in

 
6.190.3.1. 디스크

스냅샷 복원에 포함된 디스크를 지정합니다.

각 disk 매개 변수에 대해 image_id 를 지정해야 합니다.

예를 들어 식별자가 123 인 가상 시스템의 식별자 456 이 있는 스냅샷을 복원하려면 식별자 111image_id222 인 디스크를 포함하여 다음과 같이 요청을 보냅니다.

POST /ovirt-engine/api/vms/123/snapshots/456/restore

요청 본문:

<action>
  <disks>
    <disk id="111">
      <image_id>222</image_id>
    </disk>
  </disks>
</action>

6.191. SnapshotCdrom

Expand
표 6.583. 메서드 요약
이름요약

get

 

6.191.1. GET가져오기

Expand
표 6.584. 매개변수 요약
이름유형방향요약

cdrom

CDROM

Out

 

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

6.191.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.192. SnapshotCdroms

가상 머신 스냅샷의 CD-ROM 장치 세트를 관리합니다.

Expand
표 6.585. 메서드 요약
이름요약

list

스냅샷의 CD-ROM 장치 목록을 반환합니다.

6.192.1. GET나열

스냅샷의 CD-ROM 장치 목록을 반환합니다.

반환된 CD-ROM 장치 목록의 순서는 보장되지 않습니다.

Expand
표 6.586. 매개변수 요약
이름유형방향요약

cdroms

Cdrom[]

Out

 

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 최대 CDROMS 수를 설정합니다.

6.192.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.192.1.2. max

반환할 최대 CDROMS 수를 설정합니다. 지정하지 않으면 모든 CDROMS가 반환됩니다.

6.193. SnapshotDisk

Expand
표 6.587. 메서드 요약
이름요약

get

 

6.193.1. GET가져오기

Expand
표 6.588. 매개변수 요약
이름유형방향요약

disk

디스크

Out

 

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

6.193.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.194. SnapshotDisks

스냅샷의 디스크 집합을 관리합니다.

Expand
표 6.589. 메서드 요약
이름요약

list

스냅샷의 디스크 목록을 반환합니다.

6.194.1. GET나열

스냅샷의 디스크 목록을 반환합니다.

반환된 디스크 목록의 순서는 보장되지 않습니다.

Expand
표 6.590. 매개변수 요약
이름유형방향요약

디스크

Disk[]

Out

 

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 최대 디스크 수를 설정합니다.

6.194.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.194.1.2. max

반환할 최대 디스크 수를 설정합니다. 지정하지 않으면 모든 디스크가 반환됩니다.

6.195. SnapshotNic

Expand
표 6.591. 메서드 요약
이름요약

get

 

6.195.1. GET가져오기

Expand
표 6.592. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

nic

NIC

Out

 
6.195.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.196. SnapshotNics

스냅샷의 NIC 세트를 관리합니다.

Expand
표 6.593. 메서드 요약
이름요약

list

스냅샷의 NIC 목록을 반환합니다.

6.196.1. GET나열

스냅샷의 NIC 목록을 반환합니다.

반환된 NIC 목록의 순서는 보장되지 않습니다.

Expand
표 6.594. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 최대 NIC 수를 설정합니다.

nics

NIC []

Out

 
6.196.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.196.1.2. max

반환할 최대 NIC 수를 설정합니다. 지정하지 않으면 모든 NIC가 반환됩니다.

6.197. 스냅샷

스토리지 도메인 또는 가상 시스템의 스냅샷 세트를 관리합니다.

Expand
표 6.595. 메서드 요약
이름요약

add

가상 머신 스냅샷을 생성합니다.

list

스토리지 도메인 또는 가상 시스템의 스냅샷 목록을 반환합니다.

6.197.1. POST추가

가상 머신 스냅샷을 생성합니다.

예를 들어 가상 머신 123 의 새 스냅샷을 생성하려면 다음과 같은 요청을 보냅니다.

POST /ovirt-engine/api/vms/123/snapshots

다음과 같이 요청 본문이 있는 경우:

<snapshot>
  <description>My snapshot</description>
</snapshot>

스냅샷에 하위 디스크 세트만 포함하려면 요청 본문에 disk_attachments 요소를 추가합니다. disk_attachments 요소에 지정되지 않은 디스크는 스냅샷의 일부가 아닙니다. 비어 있는 disk_attachments 요소가 전달되면 스냅샷에 가상 머신 구성만 포함됩니다. disk_attachments 요소가 없으면 모든 디스크가 스냅샷에 포함됩니다.

각 디스크에 대해 새로운 활성 이미지 ID를 설정하기 위해 image_id 요소를 지정할 수 있습니다. 이는 백업에서 이미지 체인을 복원하는 데 사용됩니다. 즉, 스냅샷을 사용하여 디스크를 복원할 때 각 스냅샷에 관련 image_id 를 지정해야 합니다(디스크 스냅샷의 식별자는 백업과 동일).

<snapshot>
  <description>My snapshot</description>
  <disk_attachments>
    <disk_attachment>
      <disk id="123">
        <image_id>456</image_id>
      </disk>
    </disk_attachment>
  </disk_attachments>
</snapshot>
중요

스냅샷이 생성되면 persist_memorystate 속성의 기본값은 true 입니다. 즉, 가상 머신의 메모리 콘텐츠가 스냅샷에 포함될 것이며, 이는 더 긴 시간 동안 가상 머신이 일시 중지됨을 의미합니다. 이는 타이밍에 매우 민감한 애플리케이션(예: NTP 서버)에 부정적인 영향을 미칠 수 있습니다. 이 경우 특성을 false 로 설정해야 합니다.

<snapshot>
  <description>My snapshot</description>
  <persist_memorystate>false</persist_memorystate>
</snapshot>
Expand
표 6.596. 매개변수 요약
이름유형방향요약

snapshot

스냅샷

in/Out

 

6.197.2. GET나열

스토리지 도메인 또는 가상 시스템의 스냅샷 목록을 반환합니다.

반환된 스냅샷 목록의 순서는 보장되지 않습니다.

Expand
표 6.597. 매개변수 요약
이름유형방향요약

all_content

부울

in

응답에 가상 머신 스냅샷의 모든 속성을 포함해야 하는지 여부를 나타냅니다.

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 최대 스냅샷 수를 설정합니다.

snapshots

Snapshot[]

Out

 
6.197.2.1. all_content

응답에 가상 머신 스냅샷의 모든 속성을 포함해야 하는지 여부를 나타냅니다.

기본적으로 initialization.configuration.data 속성은 제외됩니다.

예를 들어 ID 123 스냅샷을 사용하여 가상 머신의 전체 표시를 검색하려면 다음과 같은 요청을 보냅니다.

GET /ovirt-engine/api/vms/123/snapshots?all_content=true
6.197.2.2. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.197.2.3. max

반환할 최대 스냅샷 수를 설정합니다. 지정하지 않으면 모든 스냅샷이 반환됩니다.

6.198. SshPublicKey

Expand
표 6.598. 메서드 요약
이름요약

get

 

제거

 

update

키를 새 리소스로 교체합니다.

6.198.1. GET가져오기

Expand
표 6.599. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

key

SshPublicKey

Out

 
6.198.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.198.2. DELETE제거

Expand
표 6.600. 매개변수 요약
이름유형방향요약

async

부울

in

제거가 비동기적으로 수행되어야 하는지 여부를 나타냅니다.

6.198.3. PUT업데이트

키를 새 리소스로 교체합니다.

중요

엔진의 버전 4.4.8 이후 이 작업은 더 이상 사용되지 않으며 이전 버전과의 호환성을 위해서만 유지됩니다. 이는 향후 삭제될 예정입니다. 대신 DELETE 및 add operation 을 사용하십시오.

Expand
표 6.601. 매개변수 요약
이름유형방향요약

async

부울

in

업데이트를 비동기적으로 수행해야 하는지 여부를 나타냅니다.

key

SshPublicKey

in/Out

 

6.199. SshPublicKeys

Expand
표 6.602. 메서드 요약
이름요약

add

 

list

사용자의 SSH 공개 키 목록을 반환합니다.

6.199.1. POST추가

Expand
표 6.603. 매개변수 요약
이름유형방향요약

key

SshPublicKey

in/Out

 

6.199.2. GET나열

사용자의 SSH 공개 키 목록을 반환합니다.

예를 들어, 식별자가 123 인 사용자의 SSH 키 목록을 검색하려면 다음과 같은 요청을 보냅니다.

GET /ovirt-engine/api/users/123/sshpublickeys

결과는 다음과 같은 XML 문서입니다.

<ssh_public_keys>
  <ssh_public_key href="/ovirt-engine/api/users/123/sshpublickeys/456" id="456">
    <content>ssh-rsa ...</content>
    <user href="/ovirt-engine/api/users/123" id="123"/>
  </ssh_public_key>
</ssh_public_keys>

다음 JSON 오브젝트

{
  "ssh_public_key": [
    {
      "content": "ssh-rsa ...",
      "user": {
        "href": "/ovirt-engine/api/users/123",
        "id": "123"
      },
      "href": "/ovirt-engine/api/users/123/sshpublickeys/456",
      "id": "456"
    }
  ]
}

반환된 키 목록의 순서는 보장되지 않습니다.

Expand
표 6.604. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

keys

SshPublicKey[]

Out

 

max

정수

in

반환할 최대 키 수를 설정합니다.

6.199.2.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.199.2.2. max

반환할 최대 키 수를 설정합니다. 지정하지 않으면 모든 키가 반환됩니다.

6.200. 통계

Expand
표 6.605. 메서드 요약
이름요약

get

 

6.200.1. GET가져오기

Expand
표 6.606. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

statistic

통계

Out

 
6.200.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.201. 통계

Expand
표 6.607. 메서드 요약
이름요약

list

통계 목록을 검색합니다.

6.201.1. GET나열

통계 목록을 검색합니다.

예를 들어 가상 머신 123 에 대한 통계를 검색하려면 다음과 같은 요청을 보냅니다.

GET /ovirt-engine/api/vms/123/statistics

결과는 다음과 같습니다.

<statistics>
  <statistic href="/ovirt-engine/api/vms/123/statistics/456" id="456">
    <name>memory.installed</name>
    <description>Total memory configured</description>
    <kind>gauge</kind>
    <type>integer</type>
    <unit>bytes</unit>
    <values>
      <value>
        <datum>1073741824</datum>
      </value>
    </values>
    <vm href="/ovirt-engine/api/vms/123" id="123"/>
  </statistic>
  ...
</statistics>

URI 끝에 ID를 지정하면 통계의 단일 부분만 검색할 수 있습니다. 즉, 다음을 의미합니다.

GET /ovirt-engine/api/vms/123/statistics/456

출력:

<statistic href="/ovirt-engine/api/vms/123/statistics/456" id="456">
  <name>memory.installed</name>
  <description>Total memory configured</description>
  <kind>gauge</kind>
  <type>integer</type>
  <unit>bytes</unit>
  <values>
    <value>
      <datum>1073741824</datum>
    </value>
  </values>
  <vm href="/ovirt-engine/api/vms/123" id="123"/>
</statistic>

반환된 통계 목록의 순서는 보장되지 않습니다.

Expand
표 6.608. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 최대 통계 수를 설정합니다.

statistics

통계 []

Out

 
6.201.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.201.1.2. max

반환할 최대 통계 수를 설정합니다. 지정하지 않으면 모든 통계가 반환됩니다.

6.202. Step

단계를 관리하는 서비스입니다.

Expand
표 6.609. 메서드 요약
이름요약

end

외부 단계 실행이 종료됨으로 표시됩니다.

get

단계를 검색합니다.

6.202.1. end POST

외부 단계 실행이 종료됨으로 표시됩니다.

예를 들어, 식별자가 123작업에 속하는 식별자( 456 )로 단계를 종료하려면 다음 요청을 보냅니다.

POST /ovirt-engine/api/jobs/123/steps/456/end

다음과 같은 요청 본문으로:

<action>
  <force>true</force>
  <succeeded>true</succeeded>
</action>
Expand
표 6.610. 매개변수 요약
이름유형방향요약

async

부울

in

비동기적으로 작업을 수행해야 하는지 여부를 나타냅니다.Indicates whether the action should be performed asynchronously.

force

부울

in

단계가 강제 종료되어야 하는지 여부를 나타냅니다.

succeeded

부울

in

단계가 성공적으로 완료됨 또는 실패로 표시되어야 하는지 여부를 나타냅니다.

6.202.1.1. succeeded

단계가 성공적으로 완료됨 또는 실패로 표시되어야 하는지 여부를 나타냅니다.

이 매개변수는 선택 사항이며 기본값은 true 입니다.

6.202.2. GET가져오기

단계를 검색합니다.

GET /ovirt-engine/api/jobs/123/steps/456

다음과 같은 XML로 응답을 받습니다.

<step href="/ovirt-engine/api/jobs/123/steps/456" id="456">
  <actions>
    <link href="/ovirt-engine/api/jobs/123/steps/456/end" rel="end"/>
  </actions>
  <description>Validating</description>
  <end_time>2016-12-12T23:07:26.627+02:00</end_time>
  <external>false</external>
  <number>0</number>
  <start_time>2016-12-12T23:07:26.605+02:00</start_time>
  <status>finished</status>
  <type>validating</type>
  <job href="/ovirt-engine/api/jobs/123" id="123"/>
</step>
Expand
표 6.611. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

Step

Step

Out

단계의 표현을 검색합니다.

6.202.2.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.203. 단계

단계를 관리하는 서비스입니다.

Expand
표 6.612. 메서드 요약
이름요약

add

기존 작업 또는 기존 단계에 외부 단계를 추가합니다.

list

단계의 표현을 검색합니다.

6.203.1. POST추가

기존 작업 또는 기존 단계에 외부 단계를 추가합니다.

예를 들어 식별자가 123작업에 단계를 추가하려면 다음 요청을 보냅니다.

POST /ovirt-engine/api/jobs/123/steps

다음과 같은 요청 본문으로:

<step>
  <description>Validating</description>
  <start_time>2016-12-12T23:07:26.605+02:00</start_time>
  <status>started</status>
  <type>validating</type>
</step>

응답은 다음과 같아야 합니다.

<step href="/ovirt-engine/api/jobs/123/steps/456" id="456">
  <actions>
    <link href="/ovirt-engine/api/jobs/123/steps/456/end" rel="end"/>
  </actions>
  <description>Validating</description>
  <link href="/ovirt-engine/api/jobs/123/steps/456/statistics" rel="statistics"/>
  <external>true</external>
  <number>2</number>
  <start_time>2016-12-13T01:06:15.380+02:00</start_time>
  <status>started</status>
  <type>validating</type>
  <job href="/ovirt-engine/api/jobs/123" id="123"/>
</step>
Expand
표 6.613. 매개변수 요약
이름유형방향요약

Step

Step

in/Out

이 단계가 추가됩니다.

6.203.2. GET나열

단계의 표현을 검색합니다.

GET /ovirt-engine/api/job/123/steps

다음과 같은 XML로 응답을 받습니다.

<steps>
  <step href="/ovirt-engine/api/jobs/123/steps/456" id="456">
    <actions>
      <link href="/ovirt-engine/api/jobs/123/steps/456/end" rel="end"/>
    </actions>
    <description>Validating</description>
    <link href="/ovirt-engine/api/jobs/123/steps/456/statistics" rel="statistics"/>
    <external>true</external>
    <number>2</number>
    <start_time>2016-12-13T01:06:15.380+02:00</start_time>
    <status>started</status>
    <type>validating</type>
    <job href="/ovirt-engine/api/jobs/123" id="123"/>
  </step>
  ...
</steps>

반환된 단계 목록의 순서는 보장되지 않습니다.

Expand
표 6.614. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 최대 단계 수를 설정합니다.

steps

Step []

Out

단계의 표현입니다.

6.203.2.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.203.2.2. max

반환할 최대 단계 수를 설정합니다. 지정하지 않으면 모든 단계가 반환됩니다.

6.204. 스토리지

Expand
표 6.615. 메서드 요약
이름요약

get

 

6.204.1. GET가져오기

Expand
표 6.616. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

report_status

부울

in

스토리지에서 LUN의 상태를 확인해야 하는지 여부를 나타냅니다.

storage

HostStorage

Out

 
6.204.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.204.1.2. report_status

스토리지에서 LUN의 상태를 확인해야 하는지 여부를 나타냅니다. LUN의 상태를 확인하는 것은 중량 작업이며 이 데이터는 사용자가 항상 필요하지는 않습니다. 이 매개 변수는 LUN의 상태 검사를 수행하지 않는 옵션을 제공합니다.

이전 버전과의 호환성을 위해 기본값은 true 입니다.

다음은 LUN 상태의 예입니다.

<host_storage id="360014051136c20574f743bdbd28177fd">
  <logical_units>
    <logical_unit id="360014051136c20574f743bdbd28177fd">
      <lun_mapping>0</lun_mapping>
      <paths>1</paths>
      <product_id>lun0</product_id>
      <serial>SLIO-ORG_lun0_1136c205-74f7-43bd-bd28-177fd5ce6993</serial>
      <size>10737418240</size>
      <status>used</status>
      <vendor_id>LIO-ORG</vendor_id>
      <volume_group_id>O9Du7I-RahN-ECe1-dZ1w-nh0b-64io-MNzIBZ</volume_group_id>
    </logical_unit>
  </logical_units>
  <type>iscsi</type>
  <host id="8bb5ade5-e988-4000-8b93-dbfc6717fe50"/>
</host_storage>

다음은 LUN 상태가 없는 예입니다.

<host_storage id="360014051136c20574f743bdbd28177fd">
  <logical_units>
    <logical_unit id="360014051136c20574f743bdbd28177fd">
      <lun_mapping>0</lun_mapping>
      <paths>1</paths>
      <product_id>lun0</product_id>
      <serial>SLIO-ORG_lun0_1136c205-74f7-43bd-bd28-177fd5ce6993</serial>
      <size>10737418240</size>
      <vendor_id>LIO-ORG</vendor_id>
      <volume_group_id>O9Du7I-RahN-ECe1-dZ1w-nh0b-64io-MNzIBZ</volume_group_id>
    </logical_unit>
  </logical_units>
  <type>iscsi</type>
  <host id="8bb5ade5-e988-4000-8b93-dbfc6717fe50"/>
</host_storage>

6.205. StorageDomain

Expand
표 6.617. 메서드 요약
이름요약

get

스토리지 도메인의 설명을 검색합니다.

isattached

스토리지 서버의 일부인 is_attached 부울 필드를 사용하여 스토리지 도메인이 데이터 센터에 이미 연결되어 있는지 쿼리하는 데 사용됩니다.

reduceluns

이 작업은 스토리지 도메인에서 논리 장치를 줄입니다.

refreshluns

이 작업은 LUN 크기를 새로 고칩니다.

제거

스토리지 도메인을 제거합니다.

update

스토리지 도메인을 업데이트합니다.

updateovfstore

이 작업은 이 스토리지 도메인의 OVF_STORE 를 강제로 업데이트합니다.

6.205.1. GET가져오기

스토리지 도메인의 설명을 검색합니다.

Expand
표 6.618. 매개변수 요약
이름유형방향요약

filter

부울

in

사용자의 권한에 따라 결과를 필터링해야 하는지 여부를 나타냅니다.

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

storage_domain

StorageDomain

Out

스토리지 도메인에 대한 설명입니다.

6.205.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.205.2. IsAttached POST

스토리지 서버의 일부인 is_attached 부울 필드를 사용하여 스토리지 도메인이 데이터 센터에 이미 연결되어 있는지 쿼리하는 데 사용됩니다. 중요: 이 API를 실행하면 호스트가 스토리지 도메인에서 연결이 끊어집니다.

Expand
표 6.619. 매개변수 요약
이름유형방향요약

async

부울

in

비동기적으로 작업을 수행해야 하는지 여부를 나타냅니다.Indicates whether the action should be performed asynchronously.

host

호스트

in

데이터 센터의 호스트를 나타냅니다.

is_attached

부울

Out

스토리지 도메인이 데이터 센터에 연결되었는지 여부를 나타냅니다.

6.205.3. reduceluns POST

이 작업은 스토리지 도메인에서 논리 장치를 줄입니다.

이렇게 하려면 제공된 논리 장치에 저장된 데이터가 다른 스토리지 도메인의 논리 단위로 이동되므로 스토리지 도메인에서만 줄어듭니다.

예를 들어 스토리지 도메인에서 두 개의 논리 장치를 줄이려면 다음과 같은 요청을 보냅니다.

POST /ovirt-engine/api/storageDomains/123/reduceluns

다음과 같이 요청 본문이 있는 경우:

 <action>
   <logical_units>
     <logical_unit id="1IET_00010001"/>
     <logical_unit id="1IET_00010002"/>
   </logical_units>
 </action>
Note that this operation is only applicable to block storage domains (i.e., storage domains with the
xref:types-storage_type[storage type] of iSCSI or FCP).
Expand
표 6.620. 매개변수 요약
이름유형방향요약

logical_units

LogicalUnit[]

in

스토리지 도메인에서 줄여야 하는 논리 단위입니다.

6.205.4. refreshluns POST

이 작업은 LUN 크기를 새로 고칩니다.

스토리지 서버에서 기본 LUN의 크기를 늘리면 사용자가 LUN 크기를 새로 고칠 수 있습니다. 이 작업은 제공된 LUN을 다시 검색하고 필요한 경우 새 크기로 데이터베이스를 업데이트합니다.

예를 들어 두 LUN의 크기를 새로 고치려면 다음과 같은 요청을 보냅니다.

POST /ovirt-engine/api/storageDomains/262b056b-aede-40f1-9666-b883eff59d40/refreshluns

다음과 같이 요청 본문이 있는 경우:

 <action>
   <logical_units>
     <logical_unit id="1IET_00010001"/>
     <logical_unit id="1IET_00010002"/>
   </logical_units>
 </action>
Expand
표 6.621. 매개변수 요약
이름유형방향요약

async

부울

in

새로 고침을 비동기적으로 수행해야 하는지 여부를 나타냅니다.Indicates if the refresh should be performed asynchronously.

logical_units

LogicalUnit[]

in

새로 고쳐야 하는 LUN입니다.

6.205.5. DELETE제거

스토리지 도메인을 제거합니다.

특수 매개 변수가 없으면 스토리지 도메인이 시스템에서 분리되고 데이터베이스에서 제거됩니다. 그러면 스토리지 도메인을 동일한 또는 다른 설정으로 가져올 수 있으며 모든 데이터를 사용할 수 있습니다. 스토리지에 액세스할 수 없는 경우 작업이 실패합니다.

destroy 매개 변수가 true 인 경우 스토리지에 액세스할 수 없는 경우에도 작업이 항상 성공하고 실패는 무시되어 데이터베이스에서 스토리지 도메인이 제거됩니다.

format 매개변수가 true 이면 실제 스토리지가 포맷되고 메타데이터가 LUN 또는 디렉터리에서 제거되므로 더 이상 동일하거나 다른 설정으로 가져올 수 없습니다.

Expand
표 6.622. 매개변수 요약
이름유형방향요약

async

부울

in

제거가 비동기적으로 수행되어야 하는지 여부를 나타냅니다.

destroy

부울

in

작업이 성공했는지, 스토리지에 액세스할 수 없는 경우에도 데이터베이스에서 스토리지 도메인이 제거되었는지 여부를 나타냅니다.

format

부울

in

실제 스토리지를 포맷해야 하는지 여부를 나타내며 기본 LUN 또는 디렉터리에서 모든 메타데이터를 제거합니다.

[source] ---- DELETE /ovirt-engine/api/storageDomains/123?format=true ----

이 매개변수는 선택 사항이며 기본값은 false 입니다.

host

문자열

in

스토리지 도메인을 제거하는 데 사용해야 하는 호스트를 나타냅니다.

6.205.5.1. destroy

작업이 성공했는지, 스토리지에 액세스할 수 없는 경우에도 데이터베이스에서 스토리지 도메인이 제거되었는지 여부를 나타냅니다.

DELETE /ovirt-engine/api/storageDomains/123?destroy=true

이 매개변수는 선택 사항이며 기본값은 false 입니다. destroy 값이 true 이면 host 매개변수가 무시됩니다.

6.205.5.2. host

스토리지 도메인을 제거하는 데 사용해야 하는 호스트를 나타냅니다.

이 매개 변수는 destroy 매개 변수가 포함되고 해당 값이 true 인 경우를 제외하고 필수입니다. 이 경우 host 매개변수는 무시됩니다.

값에는 호스트의 이름 또는 식별자가 포함되어야 합니다. 예를 들어 myhost 라는 호스트를 사용하여 식별자가 123 인 스토리지 도메인을 제거하려면 다음과 같은 요청을 보냅니다.

DELETE /ovirt-engine/api/storageDomains/123?host=myhost

6.205.6. PUT업데이트

스토리지 도메인을 업데이트합니다.

StorageDomain 의 속성이 생성된 후 모두 백업 가능한 것은 아닙니다. 업데이트 될 수있는 사람들은 이름,설명,description,warning_low_space_ Period ,critical_space_action_blockerwipe_after_delete입니다. (전문 _after_delete 특성을 변경해도 이미 존재하는 디스크의 삭제 속성은 변경되지 않습니다.)

식별자가 123 인 스토리지 도메인의 namewipe_after_delete 속성을 업데이트하려면 다음과 같이 요청을 보냅니다.

PUT /ovirt-engine/api/storageDomains/123

다음과 같이 요청 본문을 사용합니다.

<storage_domain>
  <name>data2</name>
  <wipe_after_delete>true</wipe_after_delete>
</storage_domain>
Expand
표 6.623. 매개변수 요약
이름유형방향요약

async

부울

in

업데이트를 비동기적으로 수행해야 하는지 여부를 나타냅니다.

storage_domain

StorageDomain

in/Out

업데이트된 스토리지 도메인.

6.205.7. updateovfstore POST

이 작업은 이 스토리지 도메인의 OVF_STORE 를 강제로 업데이트합니다.

OVF_STORE 는 스토리지 도메인에 상주하는 가상 머신 및 디스크의 메타데이터가 포함된 디스크 이미지입니다. 이 메타데이터는 도메인을 다른 데이터 센터 또는 다른 설치로 가져오거나 내보내는 경우 사용됩니다.

기본적으로 OVF_STORE 는 주기적으로 업데이트되지만(기본적으로 60분으로 설정) 중요한 변경 후 또는 OVF_STORE 가 손상되었다고 생각하는 경우 업데이트를 강제로 적용할 수 있습니다.

사용자가 시작할 때 OVF_STORE 업데이트는 업데이트가 필요한지 여부에 관계없이 수행됩니다.

Expand
표 6.624. 매개변수 요약
이름유형방향요약

async

부울

in

OVF_STORE 업데이트가 비동기적으로 수행되어야 하는지 여부를 나타냅니다.

6.206. StorageDomainContentDisk

Expand
표 6.625. 메서드 요약
이름요약

get

 

6.206.1. GET가져오기

Expand
표 6.626. 매개변수 요약
이름유형방향요약

disk

디스크

Out

 

filter

부울

in

사용자의 권한에 따라 결과를 필터링해야 하는지 여부를 나타냅니다.

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

6.206.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.207. StorageDomainContentDisks

스토리지 도메인에서 사용 가능한 디스크 세트를 관리합니다.

Expand
표 6.627. 메서드 요약
이름요약

list

스토리지 도메인에서 사용 가능한 디스크 목록을 반환합니다.

6.207.1. GET나열

스토리지 도메인에서 사용 가능한 디스크 목록을 반환합니다.

반환된 디스크 목록의 순서는 sortby 절이 검색 매개 변수에 포함된 경우에만 보장됩니다.

Expand
표 6.628. 매개변수 요약
이름유형방향요약

case_sensitive

부울

in

검색 매개 변수를 사용하여 수행된 검색이 대소문자를 고려하여 수행해야 하는지 여부를 나타냅니다.

디스크

Disk[]

Out

 

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 최대 디스크 수를 설정합니다.

search

문자열

in

반환된 디스크를 제한하는 데 사용되는 쿼리 문자열입니다.

6.207.1.1. case_sensitive

검색 매개 변수를 사용하여 수행된 검색이 대소문자를 고려하여 수행해야 하는지 여부를 나타냅니다. 기본값은 true 입니다. 즉, 해당 케이스가 고려됩니다. 대소문자를 무시하고자 하는 경우 false 로 설정합니다.

6.207.1.2. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.207.1.3. max

반환할 최대 디스크 수를 설정합니다. 지정하지 않으면 모든 디스크가 반환됩니다.

6.208. StorageDomainDisk

스토리지 도메인에서 사용 가능한 단일 디스크를 관리합니다.

중요

엔진의 버전 4.2부터 이 서비스는 스토리지 도메인에서 사용 가능한 디스크를 나열하고 등록되지 않은 디스크를 등록하기 위한 용도로만 사용됩니다. 디스크를 복사, 디스크 등의 이동과 같은 다른 모든 작업은 더 이상 사용되지 않으며 향후 제거될 예정입니다. 이러한 작업을 수행하려면 시스템의 모든 디스크를 관리하는 서비스 또는 특정 디스크를 관리하는 서비스를 사용합니다.

Expand
표 6.629. 메서드 요약
이름요약

복사

지정된 스토리지 도메인에 디스크를 복사합니다.

export

디스크를 내보내기 스토리지 도메인으로 내보냅니다.

get

디스크의 설명을 검색합니다.

이동

디스크를 다른 스토리지 도메인으로 이동합니다.

감소

디스크 이미지의 크기를 줄입니다.

제거

디스크를 제거합니다.

sparsify

디스크를 확장합니다.

update

디스크를 업데이트합니다.

6.208.1. POST복사

지정된 스토리지 도메인에 디스크를 복사합니다.

중요

엔진의 버전 4.2부터 이 작업은 더 이상 사용되지 않으며 이전 버전과의 호환성을 위해서만 유지됩니다. 이는 향후 삭제될 예정입니다. 디스크를 복사하려면 해당 디스크를 관리하는 서비스의 복사 작업을 사용합니다.

Expand
표 6.630. 매개변수 요약
이름유형방향요약

disk

디스크

in

결과 디스크에 대한 설명입니다.

storage_domain

StorageDomain

in

새 디스크가 생성될 스토리지 도메인입니다.

6.208.2. 내보내기 POST

디스크를 내보내기 스토리지 도메인으로 내보냅니다.

중요

엔진의 버전 4.2부터 이 작업은 더 이상 사용되지 않으며 이전 버전과의 호환성을 위해서만 유지됩니다. 이는 향후 삭제될 예정입니다. 디스크를 내보내려면 해당 디스크를 관리하는 서비스의 내보내기 작업을 사용합니다.

Expand
표 6.631. 매개변수 요약
이름유형방향요약

storage_domain

StorageDomain

in

디스크를 내보내야 하는 내보내기 스토리지 도메인입니다.

6.208.3. GET가져오기

디스크의 설명을 검색합니다.

Expand
표 6.632. 매개변수 요약
이름유형방향요약

disk

디스크

Out

디스크에 대한 설명입니다.

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

6.208.3.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.208.4. POST이동

디스크를 다른 스토리지 도메인으로 이동합니다.

중요

엔진의 버전 4.2부터 이 작업은 더 이상 사용되지 않으며 이전 버전과의 호환성을 위해서만 유지됩니다. 이는 향후 삭제될 예정입니다. 디스크를 이동하려면 해당 디스크를 관리하는 서비스의 이동 작업을 사용합니다.

Expand
표 6.633. 매개변수 요약
이름유형방향요약

async

부울

in

비동기적으로 이동을 수행할지 여부를 나타냅니다.Indicates if the move should be performed asynchronously.

filter

부울

in

사용자의 권한에 따라 결과를 필터링해야 하는지 여부를 나타냅니다.

storage_domain

StorageDomain

in

디스크를 이동할 스토리지 도메인입니다.

6.208.5. POST단축

디스크 이미지의 크기를 줄입니다.

논리 볼륨에서 reduce 를 호출합니다(즉, 블록 스토리지 도메인에만 적용 가능). 이는 비실행 중인 가상 머신에 연결된 유동 디스크 및 디스크에 적용됩니다. 최적 크기가 자동으로 계산되므로 크기를 지정할 필요가 없습니다.

Expand
표 6.634. 매개변수 요약
이름유형방향요약

async

부울

in

제거가 비동기적으로 수행되어야 하는지 여부를 나타냅니다.

6.208.6. DELETE제거

디스크를 제거합니다.

중요

엔진의 버전 4.2부터 이 작업은 더 이상 사용되지 않으며 이전 버전과의 호환성을 위해서만 유지됩니다. 이는 향후 삭제될 예정입니다. 디스크를 제거하려면 해당 디스크를 관리하는 서비스의 제거 작업을 사용합니다.

6.208.7. sparsify POST

디스크를 확장합니다.

중요

엔진의 버전 4.2부터 이 작업은 더 이상 사용되지 않으며 이전 버전과의 호환성을 위해서만 유지됩니다. 이는 향후 삭제될 예정입니다. 디스크를 제거하려면 해당 디스크를 관리하는 서비스의 제거 작업을 사용합니다.

6.208.8. PUT업데이트

디스크를 업데이트합니다.

중요

엔진의 버전 4.2부터 이 작업은 더 이상 사용되지 않으며 이전 버전과의 호환성을 위해서만 유지됩니다. 이는 향후 삭제될 예정입니다. 디스크를 업데이트하려면 해당 디스크를 관리하는 서비스의 업데이트 작업을 사용합니다.

Expand
표 6.635. 매개변수 요약
이름유형방향요약

disk

디스크

in/Out

디스크에 적용할 업데이트입니다.

6.209. StorageDomainDisks

특정 스토리지 도메인 내에서 사용 가능한 디스크 컬렉션을 관리합니다.

Expand
표 6.636. 메서드 요약
이름요약

add

디스크를 추가하거나 등록합니다.

list

스토리지 도메인에서 사용할 수 있는 디스크 목록을 검색합니다.

6.209.1. POST추가

디스크를 추가하거나 등록합니다.

중요

Red Hat Virtualization Manager 버전 4.2 이후 이 작업은 더 이상 사용되지 않으며 이전 버전과의 호환성을 위해서만 유지됩니다. 이는 향후 삭제될 예정입니다. 새 디스크를 추가하려면 시스템의 디스크를 관리하는 서비스의 추가 작업을 사용합니다. 등록되지 않은 디스크를 등록하려면 해당 디스크를 관리하는 서비스의 register 작업을 사용합니다.

Expand
표 6.637. 매개변수 요약
이름유형방향요약

disk

디스크

in/Out

추가하거나 등록할 디스크입니다.

등록되지 않음

부울

in

새 디스크를 추가해야 하는지 또는 기존 등록되지 않은 디스크를 등록해야 하는지 여부를 나타냅니다.

6.209.1.1. 등록되지 않음

새 디스크를 추가해야 하는지 또는 기존 등록되지 않은 디스크를 등록해야 하는지 여부를 나타냅니다. 값이 true 인 경우 등록할 디스크의 식별자를 제공해야 합니다. 예를 들어 ID 456 으로 디스크를 등록하려면 다음과 같은 요청을 보냅니다.

POST /ovirt-engine/api/storagedomains/123/disks?unregistered=true

다음과 같이 요청 본문이 있는 경우:

<disk id="456"/>

값이 false 이면 스토리지 도메인에 새 디스크가 생성됩니다. 이 경우 provisioned_size,format, name 속성이 필수입니다. 예를 들어 1GiB의 쓰기 디스크에 새 복사본 을 생성하려면 다음과 같은 요청을 보냅니다.

POST /ovirt-engine/api/storagedomains/123/disks

다음과 같이 요청 본문이 있는 경우:

<disk>
  <name>mydisk</name>
  <format>cow</format>
  <provisioned_size>1073741824</provisioned_size>
</disk>

기본값은 false입니다.

이 매개변수는 Red Hat Virtualization Manager 버전 4.2부터 더 이상 사용되지 않습니다.

6.209.2. GET나열

스토리지 도메인에서 사용할 수 있는 디스크 목록을 검색합니다.

반환된 디스크 목록의 순서는 보장되지 않습니다.

Expand
표 6.638. 매개변수 요약
이름유형방향요약

디스크

Disk[]

Out

검색된 디스크 목록입니다.

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 최대 디스크 수를 설정합니다.

등록되지 않음

부울

in

스토리지 도메인에서 등록된 디스크 또는 등록되지 않은 디스크 목록을 검색할지 여부를 나타냅니다.

6.209.2.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.209.2.2. max

반환할 최대 디스크 수를 설정합니다. 지정하지 않으면 모든 디스크가 반환됩니다.

6.209.2.3. 등록되지 않음

스토리지 도메인에서 등록된 디스크 또는 등록되지 않은 디스크 목록을 검색할지 여부를 나타냅니다. 스토리지 도메인의 등록되지 않은 디스크 목록을 가져오려면 호출에 등록되지 않은 플래그가 표시되어야 합니다. 예를 들어 등록되지 않은 디스크 목록을 가져오려면 REST API 호출이 다음과 같이 표시됩니다.

GET /ovirt-engine/api/storagedomains/123/disks?unregistered=true

등록되지 않은 플래그의 기본값은 false 입니다. 요청은 연결된 스토리지 도메인에만 적용됩니다.

6.210. StorageDomainServerConnection

Expand
표 6.639. 메서드 요약
이름요약

get

 

제거

스토리지 연결을 스토리지에서 분리합니다.

6.210.1. GET가져오기

Expand
표 6.640. 매개변수 요약
이름유형방향요약

연결

StorageConnection

Out

 

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

6.210.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.210.2. DELETE제거

스토리지 연결을 스토리지에서 분리합니다.

Expand
표 6.641. 매개변수 요약
이름유형방향요약

async

부울

in

비동기적으로 작업을 수행해야 하는지 여부를 나타냅니다.Indicates whether the action should be performed asynchronously.

6.211. StorageDomainServerConnections

스토리지 도메인에 존재하는 스토리지 서버에 대한 연결 집합을 관리합니다.

Expand
표 6.642. 메서드 요약
이름요약

add

 

list

스토리지 도메인에 있는 스토리지 서버에 대한 연결 목록을 반환합니다.

6.211.1. POST추가

Expand
표 6.643. 매개변수 요약
이름유형방향요약

연결

StorageConnection

in/Out

 

6.211.2. GET나열

스토리지 도메인에 있는 스토리지 서버에 대한 연결 목록을 반환합니다.

반환된 연결 목록의 순서는 보장되지 않습니다.

Expand
표 6.644. 매개변수 요약
이름유형방향요약

연결

StorageConnection[]

Out

 

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 최대 연결 수를 설정합니다.

6.211.2.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.211.2.2. max

반환할 최대 연결 수를 설정합니다. 지정하지 않으면 모든 연결이 반환됩니다.

6.212. StorageDomainTemplate

Expand
표 6.645. 메서드 요약
이름요약

get

 

import

내보내기 스토리지 도메인에서 템플릿을 가져오는 작업입니다.

register

템플릿을 등록하고 복사 프로세스 없이 템플릿 및 디스크의 구성을 데이터베이스에 삽입하여 데이터 도메인에서 템플릿을 가져옵니다.

제거

 

6.212.1. GET가져오기

Expand
표 6.646. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

template

템플릿

Out

 
6.212.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.212.2. POST가져오기

내보내기 스토리지 도메인에서 템플릿을 가져오는 작업입니다.

예를 들어 스토리지 도메인( 123 )에서 템플릿( 456 )을 가져오려면 다음 요청을 보냅니다.

POST /ovirt-engine/api/storagedomains/123/templates/456/import

다음과 같은 요청 본문으로:

<action>
  <storage_domain>
    <name>myexport</name>
  </storage_domain>
  <cluster>
    <name>mycluster</name>
  </cluster>
</action>

클러스터 ID 또는 이름을 지정하지 않고 엔터티를 등록하면 엔터티 OVF의 클러스터 이름이 사용됩니다(등록 요청에 클러스터 매핑도 포함되지 않는 경우).

Expand
표 6.647. 매개변수 요약
이름유형방향요약

async

부울

in

비동기적으로 가져오기를 수행해야 하는지 여부를 나타냅니다.Indicates if the import should be performed asynchronously.

clone

부울

in

선택적 복제 매개 변수를 사용하여 가져온 템플릿 및 해당 엔터티에 대한 새 UUID를 생성합니다.

cluster

Cluster

in

 

exclusive

부울

in

 

storage_domain

StorageDomain

in

 

template

템플릿

in

 

vm

Vm

in

 
6.212.2.1. clone

선택적 복제 매개 변수를 사용하여 가져온 템플릿 및 해당 엔터티에 대한 새 UUID를 생성합니다.

다른 Red Hat Virtualization 환경에서 내보낸 템플릿을 사용하여 내보내기 도메인에서 템플릿을 가져올 때 clone 매개변수를 false 로 설정하여 템플릿을 가져올 수 있습니다.

6.212.3. POST등록

템플릿을 등록하고 복사 프로세스 없이 템플릿 및 디스크의 구성을 데이터베이스에 삽입하여 데이터 도메인에서 템플릿을 가져옵니다.

Expand
표 6.648. 매개변수 요약
이름유형방향요약

allow_partial_import

부울

in

일부 디스크에만 템플릿을 등록할 수 있는지 여부를 나타냅니다.

async

부울

in

등록을 비동기적으로 수행해야 하는지 여부를 나타냅니다.

clone

부울

in

 

cluster

Cluster

in

 

exclusive

부울

in

 

registration_configuration

RegistrationConfiguration

in

이 매개변수는 템플릿을 등록하는 방법을 설명합니다.

template

템플릿

in

 

vnic_profile_mappings

VnicProfileMapping[]

in

가져오기\register 프로세스 중에 적용할 가상 NIC 프로파일의 매핑 규칙을 설명하는 더 이상 사용되지 않는 속성입니다.

6.212.3.1. allow_partial_import

일부 디스크에만 템플릿을 등록할 수 있는지 여부를 나타냅니다.

이 플래그가 true 이면 이미지를 찾을 수 없는 경우 검증 프로세스에서 시스템이 실패하지 않습니다. 대신, 누락된 디스크 없이 템플릿을 등록할 수 있습니다. 이는 주로 일부 스토리지 도메인을 사용할 수 없는 경우 템플릿을 등록하는 동안 사용됩니다. 기본값은 false입니다.

6.212.3.2. registration_configuration

이 매개변수는 템플릿을 등록하는 방법을 설명합니다.

이 매개변수는 선택 사항입니다. 매개 변수를 지정하지 않으면 템플릿이 원래 환경에 생성된 것과 동일한 구성으로 등록됩니다.

6.212.3.3. vnic_profile_mappings

가져오기\register 프로세스 중에 적용할 가상 NIC 프로파일의 매핑 규칙을 설명하는 더 이상 사용되지 않는 속성입니다.

주의

이 속성은 엔진의 버전 4.2.1부터 더 이상 사용되지 않으며 이전 버전과의 호환성을 위해서만 보존됩니다. 이는 향후 삭제될 예정입니다. vnic_profile_mappings 를 지정하려면 RegistrationConfiguration 유형 내에 vnic_profile_mappings 속성을 사용합니다.

6.212.4. DELETE제거

Expand
표 6.649. 매개변수 요약
이름유형방향요약

async

부울

in

제거가 비동기적으로 수행되어야 하는지 여부를 나타냅니다.

6.213. StorageDomainTemplates

스토리지 도메인에서 사용 가능한 템플릿 세트를 관리합니다.

Expand
표 6.650. 메서드 요약
이름요약

list

스토리지 도메인에서 사용할 수 있는 템플릿 목록을 반환합니다.

6.213.1. GET나열

스토리지 도메인에서 사용할 수 있는 템플릿 목록을 반환합니다.

반환된 템플릿 목록의 순서는 보장되지 않습니다.

Expand
표 6.651. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 최대 템플릿 수를 설정합니다.

템플릿

템플릿 []

Out

 

등록되지 않음

부울

in

스토리지 도메인에 디스크가 포함된 등록된 템플릿 또는 등록되지 않은 템플릿 목록을 검색할지 여부를 나타냅니다.

6.213.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.213.1.2. max

반환할 최대 템플릿 수를 설정합니다. 지정하지 않으면 모든 템플릿이 반환됩니다.

6.213.1.3. 등록되지 않음

스토리지 도메인에 디스크가 포함된 등록된 템플릿 또는 등록되지 않은 템플릿 목록을 검색할지 여부를 나타냅니다. 등록되지 않은 템플릿 목록을 가져오려면 호출에서 등록되지 않은 플래그를 지정해야 합니다. 예를 들어 등록되지 않은 템플릿 목록을 가져오려면 REST API 호출이 다음과 같이 표시됩니다.

GET /ovirt-engine/api/storagedomains/123/templates?unregistered=true

등록되지 않은 플래그의 기본값은 false 입니다. 요청은 연결된 스토리지 도메인에만 적용됩니다.

6.214. StorageDomainVm

Expand
표 6.652. 메서드 요약
이름요약

get

 

import

내보내기 스토리지 도메인에서 가상 머신을 가져옵니다.

register

 

제거

내보내기 스토리지 도메인에서 가상 머신을 삭제합니다.

6.214.1. GET가져오기

Expand
표 6.653. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

vm

Vm

Out

 
6.214.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.214.2. POST가져오기

내보내기 스토리지 도메인에서 가상 머신을 가져옵니다.

예를 들어 다음과 같은 요청을 보냅니다.For example, send a request like this:

POST /ovirt-engine/api/storagedomains/123/vms/456/import

다음과 같이 요청 본문이 있는 경우:

<action>
  <storage_domain>
    <name>mydata</name>
  </storage_domain>
  <cluster>
    <name>mycluster</name>
  </cluster>
</action>

가상 머신을 새 엔터티로 가져오려면 clone 매개 변수를 추가합니다.

<action>
  <storage_domain>
    <name>mydata</name>
  </storage_domain>
  <cluster>
    <name>mycluster</name>
  </cluster>
  <clone>true</clone>
  <vm>
    <name>myvm</name>
  </vm>
</action>

가져올 디스크를 선택하려면 선택적 disks 매개변수를 포함합니다. 예를 들어 식별자가 123456 인 템플릿의 디스크를 가져오려면 다음 요청 본문을 보냅니다.

<action>
  <cluster>
    <name>mycluster</name>
  </cluster>
  <vm>
    <name>myvm</name>
  </vm>
  <disks>
    <disk id="123"/>
    <disk id="456"/>
  </disks>
</action>

클러스터 ID 또는 이름을 지정하지 않고 엔터티를 등록하면 엔터티 OVF의 클러스터 이름이 사용됩니다(등록 요청에 클러스터 매핑도 포함되지 않는 경우).

Expand
표 6.654. 매개변수 요약
이름유형방향요약

async

부울

in

비동기적으로 가져오기를 수행해야 하는지 여부를 나타냅니다.Indicates if the import should be performed asynchronously.

clone

부울

in

가져온 가상 머신의 식별자를 다시 생성해야 하는지 여부를 나타냅니다.

cluster

Cluster

in

 

collapse_snapshots

부울

in

가져온 가상 머신의 스냅샷을 축소해야 하므로 스냅샷이 없는 가상 머신이 생성됩니다.

exclusive

부울

in

 

storage_domain

StorageDomain

in

 

vm

Vm

in

 
6.214.2.1. clone

가져온 가상 머신의 식별자를 다시 생성해야 하는지 여부를 나타냅니다.

기본적으로 가상 머신을 가져올 때 식별자는 보존됩니다. 즉, 식별자가 고유해야 하므로 동일한 가상 머신을 여러 번 가져올 수 없습니다. 기본값이 false 이므로 동일한 머신을 여러 번 가져올 수 있도록 하려면 이 매개변수를 true 로 설정합니다.

6.214.2.2. collapse_snapshots

가져온 가상 머신의 스냅샷을 축소해야 하므로 스냅샷이 없는 가상 머신이 생성됩니다.

이 매개변수는 선택 사항이며 기본값을 명시적으로 지정하지 않은 경우 기본값은 false 입니다.

6.214.3. POST등록

Expand
표 6.655. 매개변수 요약
이름유형방향요약

allow_partial_import

부울

in

가상 머신이 일부 디스크에만 등록할 수 있는지 여부를 나타냅니다.

async

부울

in

등록을 비동기적으로 수행해야 하는지 여부를 나타냅니다.

clone

부울

in

 

cluster

Cluster

in

 

reassign_bad_macs

부울

in

엔진에 의해 가져오기 프로세스 중에 문제가 있는 MAC 주소를 다시 할당해야 하는지 여부를 나타냅니다.

registration_configuration

RegistrationConfiguration

in

이 매개변수는 가상 시스템을 등록하는 방법을 설명합니다.

vm

Vm

in

 

vnic_profile_mappings

VnicProfileMapping[]

in

가져오기\register 프로세스 중에 적용할 가상 NIC 프로파일의 매핑 규칙을 설명하는 더 이상 사용되지 않는 속성입니다.

6.214.3.1. allow_partial_import

가상 머신이 일부 디스크에만 등록할 수 있는지 여부를 나타냅니다.

이 플래그가 true 이면 이미지를 찾을 수 없는 경우 검증 프로세스에서 엔진이 실패하지 않습니다. 대신, 누락된 디스크 없이 가상 시스템을 등록할 수 있습니다. 이는 주로 일부 스토리지 도메인을 사용할 수 없는 경우 가상 시스템을 등록하는 동안 사용됩니다. 기본값은 false입니다.

6.214.3.2. reassign_bad_macs

엔진에 의해 가져오기 프로세스 중에 문제가 있는 MAC 주소를 다시 할당해야 하는지 여부를 나타냅니다.

다음 중 하나에 해당하는 경우 MAC 주소는 문제가 있는 것으로 간주됩니다.

  • 대상 환경의 가상 머신에 이미 할당된 MAC 주소와 충돌합니다.
  • 이는 대상 MAC 주소 풀의 범위 밖에 없습니다.
6.214.3.3. registration_configuration

이 매개변수는 가상 시스템을 등록하는 방법을 설명합니다.

이 매개변수는 선택 사항입니다. 매개 변수를 지정하지 않으면 가상 머신이 생성된 원래 환경에 있는 것과 동일한 구성으로 등록됩니다.

6.214.3.4. vnic_profile_mappings

가져오기\register 프로세스 중에 적용할 가상 NIC 프로파일의 매핑 규칙을 설명하는 더 이상 사용되지 않는 속성입니다.

주의

이 속성은 엔진의 버전 4.2.1부터 더 이상 사용되지 않으며 이전 버전과의 호환성을 위해서만 보존됩니다. 이는 향후 삭제될 예정입니다. vnic_profile_mappings 를 지정하려면 RegistrationConfiguration 유형 내에 vnic_profile_mappings 속성을 사용합니다.

6.214.4. DELETE제거

내보내기 스토리지 도메인에서 가상 머신을 삭제합니다.

예를 들어 스토리지 도메인( 123 )에서 가상 머신(4656)을 삭제하려면 다음과 같은 요청을 보냅니다.

DELETE /ovirt-engine/api/storagedomains/123/vms/456
Expand
표 6.656. 매개변수 요약
이름유형방향요약

async

부울

in

제거가 비동기적으로 수행되어야 하는지 여부를 나타냅니다.

6.215. StorageDomainVmDiskAttachment

내보내기 도메인에서 가상 머신에 연결된 디스크의 세부 정보를 반환합니다.

Expand
표 6.657. 메서드 요약
이름요약

get

모든 속성과 디스크 링크가 포함된 첨부 파일의 세부 정보를 반환합니다.

6.215.1. GET가져오기

모든 속성과 디스크 링크가 포함된 첨부 파일의 세부 정보를 반환합니다.

Expand
표 6.658. 매개변수 요약
이름유형방향요약

첨부 파일

DiskAttachment

Out

디스크 연결.

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

6.215.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.216. StorageDomainVmDiskAttachments

내보내기 도메인에서 가상 시스템에 연결된 디스크의 세부 정보를 반환합니다.

Expand
표 6.659. 메서드 요약
이름요약

list

가상 머신에 연결된 디스크를 나열합니다.

6.216.1. GET나열

가상 머신에 연결된 디스크를 나열합니다.

디스크 첨부 파일의 반환 목록 순서는 보장되지 않습니다.

Expand
표 6.660. 매개변수 요약
이름유형방향요약

첨부 파일

DiskAttachment[]

Out

 

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

6.216.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.217. StorageDomainVms

내보내기 스토리지 도메인의 가상 머신을 나열합니다.

예를 들어 식별자가 123 인 스토리지 도메인에서 사용 가능한 가상 머신을 검색하려면 다음 요청을 보냅니다.

GET /ovirt-engine/api/storagedomains/123/vms

다음 응답 본문을 반환합니다.Returns the following response body:

<vms>
  <vm id="456" href="/api/storagedomains/123/vms/456">
    <name>vm1</name>
    ...
    <storage_domain id="123" href="/api/storagedomains/123"/>
    <actions>
      <link rel="import" href="/api/storagedomains/123/vms/456/import"/>
    </actions>
  </vm>
</vms>

이러한 컬렉션의 가상 머신 및 템플릿은 StorageDomain 참조 및 가져오기 작업이 포함되어 있음을 제외하고 최상위 VmTemplate 컬렉션의 해당 멤버와 비슷한 표현이 있습니다.

Expand
표 6.661. 메서드 요약
이름요약

list

내보내기 스토리지 도메인의 가상 시스템 목록을 반환합니다.

6.217.1. GET나열

내보내기 스토리지 도메인의 가상 시스템 목록을 반환합니다.

반환된 가상 머신 목록의 순서는 보장되지 않습니다.

Expand
표 6.662. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 최대 가상 머신 수를 설정합니다.

등록되지 않음

부울

in

스토리지 도메인에 디스크가 포함된 등록된 가상 시스템 또는 등록되지 않은 가상 머신 목록을 검색할지 여부를 나타냅니다.

vm

Vm[]

Out

 
6.217.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.217.1.2. max

반환할 최대 가상 머신 수를 설정합니다. 지정하지 않으면 모든 가상 머신이 반환됩니다.

6.217.1.3. 등록되지 않음

스토리지 도메인에 디스크가 포함된 등록된 가상 시스템 또는 등록되지 않은 가상 머신 목록을 검색할지 여부를 나타냅니다. 등록되지 않은 가상 시스템 목록을 가져오려면 호출에 등록되지 않은 플래그를 지정해야 합니다. 예를 들어 등록되지 않은 가상 머신 목록을 가져오려면 REST API 호출이 다음과 같이 표시됩니다.

GET /ovirt-engine/api/storagedomains/123/vms?unregistered=true

등록되지 않은 플래그의 기본값은 false 입니다. 요청은 연결된 스토리지 도메인에만 적용됩니다.

6.218. StorageDomains

시스템의 스토리지 도메인 세트를 관리합니다.

Expand
표 6.663. 메서드 요약
이름요약

add

새 스토리지 도메인을 추가합니다.

list

시스템의 스토리지 도메인 목록을 반환합니다.

6.218.1. POST추가

새 스토리지 도메인을 추가합니다.

StorageDomain 을 생성하려면 이름,type,host, storage 속성이 필요합니다. id 또는 name 속성을 사용하여 host 속성을 식별합니다. Red Hat Virtualization 3.6 이상에서는 스토리지 도메인에서 기본적으로 삭제 옵션을 삭제한 후 초기화를 활성화할 수 있습니다. 이를 구성하려면 POST 요청에 wipe_after_delete 를 지정합니다. 이 옵션은 도메인이 생성된 후 편집할 수 있지만 이미 존재하는 디스크의 삭제 속성 후에는 초기화되지 않습니다.

지정된 이름으로 새 스토리지 도메인을 추가하려면 ,storage.type ,storage.addressstorage.path 를 입력하고 id가 123 인 호스트를 사용하여 다음과 같은 요청을 보냅니다.

POST /ovirt-engine/api/storageDomains

다음과 같이 요청 본문이 있는 경우:

<storage_domain>
  <name>mydata</name>
  <type>data</type>
  <storage>
    <type>nfs</type>
    <address>mynfs.example.com</address>
    <path>/exports/mydata</path>
  </storage>
  <host>
    <name>myhost</name>
  </host>
</storage_domain>

새 NFS ISO 스토리지 도메인을 생성하려면 다음과 같은 요청을 보냅니다.

<storage_domain>
  <name>myisos</name>
  <type>iso</type>
  <storage>
    <type>nfs</type>
    <address>mynfs.example.com</address>
    <path>/export/myisos</path>
  </storage>
  <host>
    <name>myhost</name>
  </host>
</storage_domain>

새 iSCSI 스토리지 도메인을 생성하려면 다음과 같은 요청을 보냅니다.

<storage_domain>
  <name>myiscsi</name>
  <type>data</type>
  <storage>
    <type>iscsi</type>
    <logical_units>
      <logical_unit id="3600144f09dbd050000004eedbd340001"/>
      <logical_unit id="3600144f09dbd050000004eedbd340002"/>
    </logical_units>
  </storage>
  <host>
    <name>myhost</name>
  </host>
</storage_domain>
Expand
표 6.664. 매개변수 요약
이름유형방향요약

storage_domain

StorageDomain

in/Out

추가할 스토리지 도메인입니다.

6.218.2. GET나열

시스템의 스토리지 도메인 목록을 반환합니다.

반환된 스토리지 도메인 목록의 순서는 sortby 절이 검색 매개 변수에 포함된 경우에만 보장됩니다.

Expand
표 6.665. 매개변수 요약
이름유형방향요약

case_sensitive

부울

in

대소문자를 고려하여 검색을 수행해야 하는지 여부를 나타냅니다.

filter

부울

in

사용자의 권한에 따라 결과를 필터링해야 하는지 여부를 나타냅니다.

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 최대 스토리지 도메인 수를 설정합니다.

search

문자열

in

반환된 스토리지 도메인을 제한하는 데 사용되는 쿼리 문자열입니다.

storage_domains

StorageDomain[]

Out

시스템의 스토리지 도메인 목록입니다.

6.218.2.1. case_sensitive

대소문자를 고려하여 검색을 수행해야 하는지 여부를 나타냅니다. 기본값은 true 입니다. 즉, 해당 케이스가 고려됩니다. 대소문자를 무시하려면 false 로 설정합니다.

6.218.2.2. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.218.2.3. max

반환할 최대 스토리지 도메인 수를 설정합니다. 지정하지 않으면 모든 스토리지 도메인이 반환됩니다.

6.219. StorageServerConnection

Expand
표 6.666. 메서드 요약
이름요약

get

 

제거

스토리지 연결을 제거합니다.

update

스토리지 연결을 업데이트합니다.

6.219.1. GET가져오기

Expand
표 6.667. 매개변수 요약
이름유형방향요약

Conection

StorageConnection

Out

 

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

6.219.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.219.2. DELETE제거

스토리지 연결을 제거합니다.

스토리지 도메인이나 LUN 디스크가 참조하는 경우에만 스토리지 연결을 삭제할 수 있습니다. 호스트 이름 또는 id는 선택 사항이며 해당 호스트와의 연결을 연결 해제(마운트 해제)합니다.

Expand
표 6.668. 매개변수 요약
이름유형방향요약

async

부울

in

제거가 비동기적으로 수행되어야 하는지 여부를 나타냅니다.

host

문자열

in

연결을 마운트 해제할 호스트의 이름 또는 식별자입니다.

6.219.2.1. host

연결을 마운트 해제할 호스트의 이름 또는 식별자입니다. 제공하지 않으면 호스트 연결이 끊어지지 않습니다.

예를 들어, 식별자( 456 )가 있는 호스트를 사용하여 식별자( 123 )가 있는 스토리지 연결을 삭제하려면 다음과 같은 요청을 보냅니다.

DELETE /ovirt-engine/api/storageconnections/123?host=456

6.219.3. PUT업데이트

스토리지 연결을 업데이트합니다.

예를 들어 NFS 스토리지 서버의 주소를 변경하려면 다음과 같은 요청을 보냅니다.

PUT /ovirt-engine/api/storageconnections/123

다음과 같이 요청 본문이 있는 경우:

<storage_connection>
  <address>mynewnfs.example.com</address>
</storage_connection>

iSCSI 스토리지 서버의 연결을 변경하려면 다음과 같은 요청을 보냅니다.

PUT /ovirt-engine/api/storageconnections/123

다음과 같이 요청 본문이 있는 경우:

<storage_connection>
  <port>3260</port>
  <target>iqn.2017-01.com.myhost:444</target>
</storage_connection>
Expand
표 6.669. 매개변수 요약
이름유형방향요약

async

부울

in

업데이트를 비동기적으로 수행해야 하는지 여부를 나타냅니다.

연결

StorageConnection

in/Out

 

force

부울

in

관련 스토리지 도메인의 상태(예:)에 관계없이 작업이 성공해야 하는지 여부를 나타냅니다.

6.219.3.1. force

관련 스토리지 도메인의 상태에 관계없이 작업이 성공해야 하는지 여부를 나타냅니다(즉, 스토리지 도메인의 상태가 유지보수가 아닌 경우에도 업데이트가 적용됨).

이 매개변수는 선택 사항이며 기본값은 false 입니다.

6.220. StorageServerConnectionExtension

Expand
표 6.670. 메서드 요약
이름요약

get

 

제거

 

update

지정된 호스트의 스토리지 서버 연결 확장을 업데이트합니다.

6.220.1. GET가져오기

Expand
표 6.671. 매개변수 요약
이름유형방향요약

extension

StorageConnectionExtension

Out

 

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

6.220.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.220.2. DELETE제거

Expand
표 6.672. 매개변수 요약
이름유형방향요약

async

부울

in

제거가 비동기적으로 수행되어야 하는지 여부를 나타냅니다.

6.220.3. PUT업데이트

지정된 호스트의 스토리지 서버 연결 확장을 업데이트합니다.

호스트( 123 )의 스토리지 연결( 456 )을 업데이트하려면 다음과 같은 요청을 보냅니다.

PUT /ovirt-engine/api/hosts/123/storageconnectionextensions/456

다음과 같이 요청 본문이 있는 경우:

<storage_connection_extension>
  <target>iqn.2016-01.com.example:mytarget</target>
  <username>myuser</username>
  <password>mypassword</password>
</storage_connection_extension>
Expand
표 6.673. 매개변수 요약
이름유형방향요약

async

부울

in

업데이트를 비동기적으로 수행해야 하는지 여부를 나타냅니다.

extension

StorageConnectionExtension

in/Out

 

6.221. StorageServerConnectionExtensions

Expand
표 6.674. 메서드 요약
이름요약

add

지정된 호스트에 대한 새 스토리지 서버 연결 확장을 생성합니다.

list

os 스토리지 연결 확장 목록을 반환합니다.

6.221.1. POST추가

지정된 호스트에 대한 새 스토리지 서버 연결 확장을 생성합니다.

확장 기능을 사용하면 사용자가 특정 호스트의 iSCSI 대상 자격 증명을 정의할 수 있습니다. 예를 들어 호스트 123 에서 iSCSI 대상에 연결할 때 myusermypassword 를 자격 증명으로 사용하려면 다음과 같은 요청을 보냅니다.

POST /ovirt-engine/api/hosts/123/storageconnectionextensions

다음과 같이 요청 본문이 있는 경우:

<storage_connection_extension>
  <target>iqn.2016-01.com.example:mytarget</target>
  <username>myuser</username>
  <password>mypassword</password>
</storage_connection_extension>
Expand
표 6.675. 매개변수 요약
이름유형방향요약

extension

StorageConnectionExtension

in/Out

 

6.221.2. GET나열

os 스토리지 연결 확장 목록을 반환합니다.

반환된 스토리지 연결 목록의 순서는 보장되지 않습니다.

Expand
표 6.676. 매개변수 요약
이름유형방향요약

extensions

StorageConnectionExtension[]

Out

 

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 최대 확장 기능 수를 설정합니다.

6.221.2.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.221.2.2. max

반환할 최대 확장 기능 수를 설정합니다. 지정하지 않으면 모든 확장이 반환됩니다.

6.222. StorageServerConnections

Expand
표 6.677. 메서드 요약
이름요약

add

새 스토리지 연결을 생성합니다.

list

스토리지 연결 목록을 반환합니다.

6.222.1. POST추가

새 스토리지 연결을 생성합니다.

예를 들어 NFS 서버 mynfs.example.com 및 NFS 공유 /export/mydata 에 대한 새 스토리지 연결을 생성하려면 다음과 같은 요청을 보냅니다.

POST /ovirt-engine/api/storageconnections

다음과 같이 요청 본문이 있는 경우:

<storage_connection>
  <type>nfs</type>
  <address>mynfs.example.com</address>
  <path>/export/mydata</path>
  <host>
    <name>myhost</name>
  </host>
</storage_connection>
Expand
표 6.678. 매개변수 요약
이름유형방향요약

연결

StorageConnection

in/Out

 

6.222.2. GET나열

스토리지 연결 목록을 반환합니다.

반환된 연결 목록의 순서는 보장되지 않습니다.

Expand
표 6.679. 매개변수 요약
이름유형방향요약

연결

StorageConnection[]

Out

 

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 최대 연결 수를 설정합니다.

6.222.2.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.222.2.2. max

반환할 최대 연결 수를 설정합니다. 지정하지 않으면 모든 연결이 반환됩니다.

6.223. 시스템

Expand
표 6.680. 메서드 요약
이름요약

get

제품 이름, 버전 번호, 관련 오브젝트 수에 대한 요약과 같은 API를 설명하는 기본 정보를 반환합니다.

reloadconfigurations

 

6.223.1. GET가져오기

제품 이름, 버전 번호, 관련 오브젝트 수에 대한 요약과 같은 API를 설명하는 기본 정보를 반환합니다.

GET /ovirt-engine/api

다음과 같은 응답이 제공됩니다.

<api>
  <link rel="capabilities" href="/api/capabilities"/>
  <link rel="clusters" href="/api/clusters"/>
  <link rel="clusters/search" href="/api/clusters?search={query}"/>
  <link rel="datacenters" href="/api/datacenters"/>
  <link rel="datacenters/search" href="/api/datacenters?search={query}"/>
  <link rel="events" href="/api/events"/>
  <link rel="events/search" href="/api/events?search={query}"/>
  <link rel="hosts" href="/api/hosts"/>
  <link rel="hosts/search" href="/api/hosts?search={query}"/>
  <link rel="networks" href="/api/networks"/>
  <link rel="roles" href="/api/roles"/>
  <link rel="storagedomains" href="/api/storagedomains"/>
  <link rel="storagedomains/search" href="/api/storagedomains?search={query}"/>
  <link rel="tags" href="/api/tags"/>
  <link rel="templates" href="/api/templates"/>
  <link rel="templates/search" href="/api/templates?search={query}"/>
  <link rel="users" href="/api/users"/>
  <link rel="groups" href="/api/groups"/>
  <link rel="domains" href="/api/domains"/>
  <link rel="vmpools" href="/api/vmpools"/>
  <link rel="vmpools/search" href="/api/vmpools?search={query}"/>
  <link rel="vms" href="/api/vms"/>
  <link rel="vms/search" href="/api/vms?search={query}"/>
  <product_info>
    <name>oVirt Engine</name>
    <vendor>ovirt.org</vendor>
    <version>
      <build>4</build>
      <full_version>4.0.4</full_version>
      <major>4</major>
      <minor>0</minor>
      <revision>0</revision>
    </version>
  </product_info>
  <special_objects>
    <blank_template href="/ovirt-engine/api/templates/00000000-0000-0000-0000-000000000000" id="00000000-0000-0000-0000-000000000000"/>
    <root_tag href="/ovirt-engine/api/tags/00000000-0000-0000-0000-000000000000" id="00000000-0000-0000-0000-000000000000"/>
  </special_objects>
  <summary>
    <hosts>
      <active>0</active>
      <total>0</total>
    </hosts>
    <storage_domains>
      <active>0</active>
      <total>1</total>
    </storage_domains>
    <users>
      <active>1</active>
      <total>1</total>
    </users>
    <vms>
      <active>0</active>
      <total>0</total>
    </vms>
  </summary>
  <time>2016-09-14T12:00:48.132+02:00</time>
</api>

진입점은 가상화 환경의 컬렉션에 대한 링크를 사용자에게 제공합니다. 각 컬렉션 링크의 rel 속성은 각 링크에 대한 참조 지점을 제공합니다.

진입점에는 product_info,special_objects요약 과 같은 기타 데이터도 포함됩니다.

Expand
표 6.681. 매개변수 요약
이름유형방향요약

api

Api

Out

 

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

6.223.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.223.2. reloadconfigurations POST

Expand
표 6.682. 매개변수 요약
이름유형방향요약

async

부울

in

다시 로드를 비동기적으로 수행해야 하는지 여부를 나타냅니다.Indicates whether the reload should be performed asynchronously.

6.224. SystemOption

시스템의 특정 구성 옵션 값을 제공하는 서비스입니다.

Expand
표 6.683. 메서드 요약
이름요약

get

특정 구성 옵션의 값을 가져옵니다.

6.224.1. GET가져오기

특정 구성 옵션의 값을 가져옵니다.

예를 들어 구성 옵션 MigrationPolicies 의 값을 검색하려면 다음과 같은 요청을 보냅니다.

GET /ovirt-engine/api/options/MigrationPolicies

해당 요청에 대한 응답은 다음과 같습니다.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<system_option href="/ovirt-engine/api/options/MigrationPolicies" id="MigrationPolicies">
    <name>MigrationPolicies</name>
    <values>
        <system_option_value>
            <value>[{"id":{"uuid":"80554327-0569-496b-bdeb-fcbbf52b827b"},...}]</value>
            <version>4.2</version>
        </system_option_value>
        <system_option_value>
            <value>[{"id":{"uuid":"80554327-0569-496b-bdeb-fcbbf52b827b"},...}]</value>
            <version>4.3</version>
        </system_option_value>
        <system_option_value>
            <value>[{"id":{"uuid":"80554327-0569-496b-bdeb-fcbbf52b827b"},...}]</value>
            <version>4.4</version>
        </system_option_value>
        <system_option_value>
            <value>[{"id":{"uuid":"80554327-0569-496b-bdeb-fcbbf52b827b"},...}]</value>
            <version>4.5</version>
        </system_option_value>
        <system_option_value>
            <value>[{"id":{"uuid":"80554327-0569-496b-bdeb-fcbbf52b827b"},...}]</value>
            <version>4.6</version>
        </system_option_value>
        <system_option_value>
            <value>[{"id":{"uuid":"80554327-0569-496b-bdeb-fcbbf52b827b"},...}]</value>
            <version>4.7</version>
        </system_option_value>
    </values>
</system_option>
참고

구성 옵션을 쿼리하려면 적절한 권한이 필요합니다. 일부 옵션은 관리자 권한이 있는 사용자만 쿼리할 수 있습니다.

중요

이전 버전과의 호환성이 없으며 옵션의 이름이나 값에 대해 보장하지 않습니다. 옵션은 제거될 수 있으며 그 의미는 언제든지 변경될 수 있습니다.

당사는 엔진과 동시에 릴리스되는 애플리케이션 이외의 애플리케이션에 이 서비스 사용을 강력히 권장하지 않습니다. 다른 애플리케이션에서의 사용은 지원되지 않습니다. 따라서 액세스 가능한 구성 옵션을 나열하는 설명서가 없습니다.

Expand
표 6.684. 매개변수 요약
이름유형방향요약

옵션

SystemOption

Out

시스템의 반환된 구성 옵션입니다.

version

문자열

in

특정 버전의 구성 옵션만 반환되도록 지정하는 선택적 version 매개변수입니다.

6.224.1.1. version

특정 버전의 구성 옵션만 반환되도록 지정하는 선택적 version 매개변수입니다. 이 매개 변수를 사용하지 않으면 모든 버전이 반환됩니다.

예를 들어 MigrationPolicies 옵션 값을 가져오고 버전 4.2 의 경우에만 다음과 같은 요청을 보냅니다.

GET /ovirt-engine/api/options/MigrationPolicies?version=4.2

해당 요청에 대한 응답은 다음과 같습니다.

<system_option href="/ovirt-engine/api/options/MigrationPolicies" id="MigrationPolicies">
    <name>MigrationPolicies</name>
    <values>
        <system_option_value>
            <value>[{"id":{"uuid":"80554327-0569-496b-bdeb-fcbbf52b827b"},...}]</value>
            <version>4.2</version>
        </system_option_value>
    </values>
</system_option>

6.225. SystemOptions

시스템의 구성 옵션 값을 제공하는 서비스입니다.

6.226. SystemPermissions

이 서비스는 새 메서드를 추가하지 않으며, 시스템 오브젝트에 할당된 권한을 관리하는 리소스의 경로를 지정하는 주석의 자리 표시자일 뿐입니다.

Expand
표 6.685. 메서드 요약
이름요약

add

특정 엔터티에 대해 사용자 또는 그룹에 새 권한을 할당합니다.

list

특정 엔티티의 모든 권한을 나열합니다.

6.226.1. POST추가

특정 엔터티에 대해 사용자 또는 그룹에 새 권한을 할당합니다.

예를 들어 ID가 123 인 가상 시스템에 UserVmManager 역할을 할당하려면 ID 456 이 다음과 같은 요청을 보냅니다.

POST /ovirt-engine/api/vms/123/permissions

다음과 같이 요청 본문이 있는 경우:

<permission>
  <role>
    <name>UserVmManager</name>
  </role>
  <user id="456"/>
</permission>

id 456 이 있는 사용자에게 SuperUser 역할을 시스템에 할당하려면 다음과 같은 요청을 보냅니다.

POST /ovirt-engine/api/permissions

다음과 같이 요청 본문이 있는 경우:

<permission>
  <role>
    <name>SuperUser</name>
  </role>
  <user id="456"/>
</permission>

사용자 대신 그룹에 권한을 할당하려는 경우 사용자 요소를 그룹 요소의 적절한 ID 로 바꾸십시오. 예를 들어 id가 123 인 클러스터에 UserRole 역할을 id 789 가 있는 그룹에 할당하려면 다음과 같은 요청을 보냅니다.

POST /ovirt-engine/api/clusters/123/permissions

다음과 같이 요청 본문이 있는 경우:

<permission>
  <role>
    <name>UserRole</name>
  </role>
  <group id="789"/>
</permission>
Expand
표 6.686. 매개변수 요약
이름유형방향요약

권한

권한

in/Out

권한입니다.

6.226.2. GET나열

특정 엔티티의 모든 권한을 나열합니다.

예를 들어 ID가 123 인 클러스터의 모든 권한을 나열하려면 다음과 같은 요청을 보냅니다.

GET /ovirt-engine/api/clusters/123/permissions
<permissions>
  <permission id="456">
    <cluster id="123"/>
    <role id="789"/>
    <user id="451"/>
  </permission>
  <permission id="654">
    <cluster id="123"/>
    <role id="789"/>
    <group id="127"/>
  </permission>
</permissions>

반환된 권한의 순서는 보장되지 않습니다.

Expand
표 6.687. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

권한

승인 []

Out

권한 목록.

6.226.2.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.227. Tag

시스템에서 특정 태그를 관리하는 서비스입니다.

Expand
표 6.688. 메서드 요약
이름요약

get

태그에 대한 정보를 가져옵니다.

제거

시스템에서 태그를 제거합니다.

update

태그 엔터티를 업데이트합니다.

6.227.1. GET가져오기

태그에 대한 정보를 가져옵니다.

예를 들어 ID 123 을 사용하여 태그에 대한 정보를 검색하려면 다음과 같은 요청을 보냅니다.

GET /ovirt-engine/api/tags/123
<tag href="/ovirt-engine/api/tags/123" id="123">
  <name>root</name>
  <description>root</description>
</tag>
Expand
표 6.689. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

tag

Tag

Out

태그입니다.

6.227.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.227.2. DELETE제거

시스템에서 태그를 제거합니다.

예를 들어, ID 123 가 있는 태그를 제거하려면 다음과 같이 요청을 보냅니다.

DELETE /ovirt-engine/api/tags/123
Expand
표 6.690. 매개변수 요약
이름유형방향요약

async

부울

in

제거가 비동기적으로 수행되어야 하는지 여부를 나타냅니다.

6.227.3. PUT업데이트

태그 엔터티를 업데이트합니다.

예를 들어 ID 123 을 사용하여 태그의 ID 456 으로 태그를 지정하도록 상위 태그를 업데이트하려면 다음과 같은 요청을 보냅니다.

PUT /ovirt-engine/api/tags/123

다음과 같이 요청 본문이 있는 경우:

<tag>
  <parent id="456"/>
</tag>

id 대신 태그 이름을 지정할 수도 있습니다. 예를 들어 ID 123 을 사용하여 태그의 이름이 mytag 로 태그되도록 상위 태그를 업데이트하려면 다음과 같은 요청을 보냅니다.

<tag>
  <parent>
    <name>mytag</name>
  </parent>
</tag>
Expand
표 6.691. 매개변수 요약
이름유형방향요약

async

부울

in

업데이트를 비동기적으로 수행해야 하는지 여부를 나타냅니다.

tag

Tag

in/Out

업데이트된 태그입니다.

6.228. 태그

시스템의 태그 컬렉션을 관리하는 서비스를 나타냅니다.

Expand
표 6.692. 메서드 요약
이름요약

add

시스템에 새 태그를 추가합니다.

list

시스템의 태그를 나열합니다.

6.228.1. POST추가

시스템에 새 태그를 추가합니다.

예를 들어 이름이 mytag 인 새 태그를 시스템에 추가하려면 다음과 같은 요청을 보냅니다.

POST /ovirt-engine/api/tags

다음과 같이 요청 본문이 있는 경우:

<tag>
  <name>mytag</name>
</tag>
참고

root 태그는 상위 태그가 지정되지 않은 경우 기본 상위 태그로 가정되는 특수 의사 태그입니다. root 태그는 삭제하거나 상위 태그를 할당할 수 없습니다.

특정 상위 태그로 새 태그를 생성하려면 다음과 같이 요청 본문을 보냅니다.

<tag>
  <name>mytag</name>
  <parent>
    <name>myparenttag</name>
  </parent>
</tag>
Expand
표 6.693. 매개변수 요약
이름유형방향요약

tag

Tag

in/Out

추가된 태그입니다.

6.228.2. GET나열

시스템의 태그를 나열합니다.

예를 들어 시스템에 있는 태그의 전체 계층 구조를 나열하려면 다음과 같은 요청을 보냅니다.

GET /ovirt-engine/api/tags
<tags>
  <tag href="/ovirt-engine/api/tags/222" id="222">
    <name>root2</name>
    <description>root2</description>
    <parent href="/ovirt-engine/api/tags/111" id="111"/>
  </tag>
  <tag href="/ovirt-engine/api/tags/333" id="333">
    <name>root3</name>
    <description>root3</description>
    <parent href="/ovirt-engine/api/tags/222" id="222"/>
  </tag>
  <tag href="/ovirt-engine/api/tags/111" id="111">
    <name>root</name>
    <description>root</description>
  </tag>
</tags>

이전 XML 출력에서는 태그의 다음 계층을 볼 수 있습니다.

root:        (id: 111)
  - root2    (id: 222)
    - root3  (id: 333)

반환된 태그 목록의 순서는 보장되지 않습니다.

Expand
표 6.694. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 최대 태그 수를 설정합니다.

tags

Tag[]

Out

시스템의 모든 태그 목록입니다.

6.228.2.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.228.2.2. max

반환할 최대 태그 수를 설정합니다. 지정하지 않으면 모든 태그가 반환됩니다.

6.229. 템플릿

가상 시스템 템플릿 및 템플릿 버전을 관리합니다.

Expand
표 6.695. 메서드 요약
이름요약

export

템플릿을 데이터 센터 내보내기 도메인으로 내보냅니다.

get

이 템플릿 또는 템플릿 버전에 대한 정보를 반환합니다.

제거

가상 머신 템플릿을 제거합니다.

update

템플릿을 업데이트합니다.

6.229.1. 내보내기 POST

템플릿을 데이터 센터 내보내기 도메인으로 내보냅니다.

예를 들어 다음 요청을 보냅니다.

POST /ovirt-engine/api/templates/123/export

다음과 같이 요청 본문이 있는 경우:

<action>
  <storage_domain id="456"/>
  <exclusive>true<exclusive/>
</action>

엔진 버전 4.2부터 템플릿을 가상 장치(OVA)로 내보낼 수도 있습니다. 예를 들어, 호스트 myhost/home/ovirt/ 디렉터리에 배치된 myvm.ova 라는 OVA 파일로 템플릿 123 을 내보내려면 다음을 수행합니다.

POST /ovirt-engine/api/templates/123/export

다음과 같이 요청 본문이 있는 경우:

<action>
  <host>
    <name>myhost</name>
  </host>
  <directory>/home/ovirt</directory>
  <filename>myvm.ova</filename>
</action>
Expand
표 6.696. 매개변수 요약
이름유형방향요약

exclusive

부울

in

이름이 같은 기존 템플릿을 덮어써야 하는지 여부를 나타냅니다.

storage_domain

StorageDomain

in

대상 내보내기 스토리지 도메인을 지정합니다.

6.229.1.1. exclusive

이름이 같은 기존 템플릿을 덮어써야 하는지 여부를 나타냅니다.

대상 도메인에 동일한 이름의 템플릿이 있는 경우 내보내기 작업은 실패한 작업을 보고합니다. 이 매개변수를 true 로 설정하여 이 동작을 변경하고 기존 템플릿을 덮어씁니다.

6.229.2. GET가져오기

이 템플릿 또는 템플릿 버전에 대한 정보를 반환합니다.

Expand
표 6.697. 매개변수 요약
이름유형방향요약

filter

부울

in

사용자의 권한에 따라 결과를 필터링해야 하는지 여부를 나타냅니다.

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

template

템플릿

Out

템플릿 또는 템플릿 버전에 대한 정보입니다.

6.229.2.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.229.3. DELETE제거

가상 머신 템플릿을 제거합니다.

DELETE /ovirt-engine/api/templates/123
Expand
표 6.698. 매개변수 요약
이름유형방향요약

async

부울

in

제거를 비동기적으로 수행해야 하는지 여부를 나타냅니다.Indicates if the removal should be performed asynchronously.

6.229.4. PUT업데이트

템플릿을 업데이트합니다.

name,description,type, cpu ,cpu,topology,os,high_availability,display,stateless,usb, and timezone elements can be updated after a template has been created.

예를 들어 1GiB 메모리가 있도록 템플릿을 업데이트하려면 다음과 같은 요청을 보냅니다.

PUT /ovirt-engine/api/templates/123

다음과 같은 요청 본문으로:

<template>
  <memory>1073741824</memory>
</template>

version_name name 속성은 템플릿 버전에 사용되는 version 속성 내에서 업데이트할 수 있는 유일한 속성입니다.

<template>
  <version>
    <version_name>mytemplate_2</version_name>
  </version>
</template>
Expand
표 6.699. 매개변수 요약
이름유형방향요약

async

부울

in

업데이트를 비동기적으로 수행해야 하는지 여부를 나타냅니다.

template

템플릿

in/Out

 

6.230. TemplateCdrom

템플릿에서 CD-ROM 장치를 관리하는 서비스입니다.

Expand
표 6.700. 메서드 요약
이름요약

get

이 CD-ROM 장치에 대한 정보를 반환합니다.

6.230.1. GET가져오기

이 CD-ROM 장치에 대한 정보를 반환합니다.

예를 들어, 템플릿 123 의 CD-ROM 장치에 대한 정보를 얻으려면 다음과 같은 요청을 보냅니다.

GET /ovirt-engine/api/templates/123/cdroms/
Expand
표 6.701. 매개변수 요약
이름유형방향요약

cdrom

CDROM

Out

CD-ROM 장치에 대한 정보

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

6.230.1.1. cdrom

CD-ROM 장치에 대한 정보

정보는 CD-ROM 장치, 템플릿 및 삽입된 디스크에 대한 참조가 포함된 cdrom 속성으로 구성됩니다.

디스크가 삽입되면 file 속성에 ISO 이미지에 대한 참조가 포함됩니다.

<cdrom href="..." id="00000000-0000-0000-0000-000000000000">
  <template href="/ovirt-engine/api/templates/123" id="123"/>
  <file id="mycd.iso"/>
</cdrom>

디스크가 삽입되지 않으면 file 속성이 보고되지 않습니다.

<cdrom href="..." id="00000000-0000-0000-0000-000000000000">
  <template href="/ovirt-engine/api/templates/123" id="123"/>
</cdrom>
6.230.1.2. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.231. TemplateCdroms

템플릿의 CD-ROM 장치를 나열합니다.

Expand
표 6.702. 메서드 요약
이름요약

list

템플릿의 CD-ROM 장치 목록을 반환합니다.

6.231.1. GET나열

템플릿의 CD-ROM 장치 목록을 반환합니다.

반환된 CD-ROM 장치 목록의 순서는 보장되지 않습니다.

Expand
표 6.703. 매개변수 요약
이름유형방향요약

cdroms

Cdrom[]

Out

템플릿의 CD-ROM 장치 목록입니다.

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 최대 CD-ROM 수를 설정합니다.

6.231.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.231.1.2. max

반환할 최대 CD-ROM 수를 설정합니다. 지정하지 않으면 모든 CD-ROM이 반환됩니다.

6.232. TemplateDisk

Expand
표 6.704. 메서드 요약
이름요약

복사

템플릿에 연결된 지정된 디스크를 특정 스토리지 도메인에 복사합니다.

export

 

get

 

제거

 

6.232.1. POST복사

템플릿에 연결된 지정된 디스크를 특정 스토리지 도메인에 복사합니다.

Expand
표 6.705. 매개변수 요약
이름유형방향요약

async

부울

in

복사본을 비동기적으로 수행해야 하는지 여부를 나타냅니다.Indicates if the copy should be performed asynchronously.

filter

부울

in

사용자의 권한에 따라 결과를 필터링해야 하는지 여부를 나타냅니다.

storage_domain

StorageDomain

in

 

6.232.2. 내보내기 POST

Expand
표 6.706. 매개변수 요약
이름유형방향요약

async

부울

in

비동기적으로 내보내기를 수행해야 하는지 여부를 나타냅니다.Indicates whether the export should be performed asynchronously.

filter

부울

in

사용자의 권한에 따라 결과를 필터링해야 하는지 여부를 나타냅니다.

storage_domain

StorageDomain

in

 

6.232.3. GET가져오기

Expand
표 6.707. 매개변수 요약
이름유형방향요약

disk

디스크

Out

 

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

6.232.3.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.232.4. DELETE제거

Expand
표 6.708. 매개변수 요약
이름유형방향요약

async

부울

in

제거가 비동기적으로 수행되어야 하는지 여부를 나타냅니다.

6.233. TemplateDiskAttachment

이 서비스는 디스크 연결을 템플릿에 관리합니다.

Expand
표 6.709. 메서드 요약
이름요약

get

첨부 파일의 세부 정보를 반환합니다.

제거

템플릿에서 디스크를 제거합니다.

6.233.1. GET가져오기

첨부 파일의 세부 정보를 반환합니다.

Expand
표 6.710. 매개변수 요약
이름유형방향요약

첨부 파일

DiskAttachment

Out

 

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

6.233.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.233.2. DELETE제거

템플릿에서 디스크를 제거합니다. 다른 스토리지 도메인에 디스크의 다른 기존 복사본이 있는 경우에만 디스크가 제거됩니다.

제거할 복사본을 결정하도록 스토리지 도메인을 지정해야 합니다(템플릿 디스크에 여러 스토리지 도메인의 복사본이 있을 수 있음).

DELETE /ovirt-engine/api/templates/{template:id}/diskattachments/{attachment:id}?storage_domain=072fbaa1-08f3-4a40-9f34-a5ca22dd1d74
Expand
표 6.711. 매개변수 요약
이름유형방향요약

force

부울

in

 

storage_domain

문자열

in

제거할 이미지가 있는 스토리지 도메인의 식별자를 지정합니다.

6.234. TemplateDiskAttachments

이 서비스는 템플릿에 연결된 디스크 세트를 관리합니다. 연결된 각 디스크는 DiskAttachment 로 표시됩니다.

Expand
표 6.712. 메서드 요약
이름요약

list

템플릿에 연결된 디스크를 나열합니다.

6.234.1. GET나열

템플릿에 연결된 디스크를 나열합니다.

첨부 파일의 반환 목록 순서는 보장되지 않습니다.

Expand
표 6.713. 매개변수 요약
이름유형방향요약

첨부 파일

DiskAttachment[]

Out

 

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

6.234.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.235. TemplateDisks

Expand
표 6.714. 메서드 요약
이름요약

list

템플릿의 디스크 목록을 반환합니다.

6.235.1. GET나열

템플릿의 디스크 목록을 반환합니다.

반환된 디스크 목록의 순서는 보장되지 않습니다.

Expand
표 6.715. 매개변수 요약
이름유형방향요약

디스크

Disk[]

Out

 

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 최대 디스크 수를 설정합니다.

6.235.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.235.1.2. max

반환할 최대 디스크 수를 설정합니다. 지정하지 않으면 모든 디스크가 반환됩니다.

6.236. TemplateGraphicsConsole

Expand
표 6.716. 메서드 요약
이름요약

get

템플릿의 그래픽 콘솔 구성을 가져옵니다.

제거

템플릿에서 그래픽 콘솔을 제거합니다.

6.236.1. GET가져오기

템플릿의 그래픽 콘솔 구성을 가져옵니다.

Expand
표 6.717. 매개변수 요약
이름유형방향요약

console

GraphicsConsole

Out

템플릿의 그래픽 콘솔에 대한 정보입니다.

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

6.236.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.236.2. DELETE제거

템플릿에서 그래픽 콘솔을 제거합니다.

Expand
표 6.718. 매개변수 요약
이름유형방향요약

async

부울

in

제거가 비동기적으로 수행되어야 하는지 여부를 나타냅니다.

6.237. TemplateGraphicsConsoles

Expand
표 6.719. 메서드 요약
이름요약

add

템플릿에 새 그래픽 콘솔을 추가합니다.

list

템플릿의 구성된 모든 그래픽 콘솔을 나열합니다.

6.237.1. POST추가

템플릿에 새 그래픽 콘솔을 추가합니다.

Expand
표 6.720. 매개변수 요약
이름유형방향요약

console

GraphicsConsole

in/Out

 

6.237.2. GET나열

템플릿의 구성된 모든 그래픽 콘솔을 나열합니다.

반환된 그래픽 콘솔 목록의 순서는 보장되지 않습니다.

Expand
표 6.721. 매개변수 요약
이름유형방향요약

콘솔

GraphicsConsole[]

Out

템플릿의 그래픽 콘솔 목록입니다.

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 최대 콘솔 수를 설정합니다.

6.237.2.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.237.2.2. max

반환할 최대 콘솔 수를 설정합니다. 지정하지 않으면 모든 콘솔이 반환됩니다.

6.238. TemplateMediatedDevice

Expand
표 6.722. 메서드 요약
이름요약

get

템플릿의 중재 장치 구성을 가져옵니다.

제거

템플릿에서 미디어된 장치를 제거합니다.

update

중재된 장치에 대한 정보를 업데이트합니다.

6.238.1. GET가져오기

템플릿의 중재 장치 구성을 가져옵니다.

Expand
표 6.723. 매개변수 요약
이름유형방향요약

device

VmMediatedDevice

Out

템플릿의 중재 장치에 대한 정보입니다.

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

6.238.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.238.2. DELETE제거

템플릿에서 미디어된 장치를 제거합니다.

Expand
표 6.724. 매개변수 요약
이름유형방향요약

async

부울

in

제거가 비동기적으로 수행되어야 하는지 여부를 나타냅니다.

6.238.3. PUT업데이트

중재된 장치에 대한 정보를 업데이트합니다.

specParams 요소를 사용하여 정보를 업데이트할 수 있습니다.

예를 들어 중재된 장치를 업데이트하려면 다음과 같은 요청을 보냅니다.

PUT /ovirt-engine/api/templates/123/mediateddevices/00000000-0000-0000-0000-000000000000
<vm_mediated_device>
  <spec_params>
    <property>
      <name>mdevType</name>
      <value>nvidia-11</value>
    </property>
  </spec_params>
</vm_mediated_device>

응답 본문:

<vm_mediated_device href="/ovirt-engine/api/templates/123/mediateddevices/00000000-0000-0000-0000-000000000000" id="00000000-0000-0000-0000-000000000000">
  <template href="/ovirt-engine/api/templates/123" id="123"/>
  <spec_params>
    <property>
      <name>mdevType</name>
      <value>nvidia-11</value>
    </property>
  </spec_params>
</vm_mediated_device>
Expand
표 6.725. 매개변수 요약
이름유형방향요약

async

부울

in

업데이트를 비동기적으로 수행해야 하는지 여부를 나타냅니다.

장치

VmMediatedDevice

in/Out

중재된 장치에 대한 정보입니다.

6.238.3.1. 장치

중재된 장치에 대한 정보입니다.

요청 데이터에 specParams 속성이 포함되어야 합니다. 응답 데이터에는 업데이트된 중재 장치에 대한 완전한 정보가 포함되어 있습니다.

6.239. TemplateMediatedDevices

템플릿의 중재 장치를 관리하는 서비스입니다.

Expand
표 6.726. 메서드 요약
이름요약

add

템플릿에 새 미디어 장치를 추가합니다.

list

구성된 템플릿 장치를 모두 나열합니다.

6.239.1. POST추가

템플릿에 새 미디어 장치를 추가합니다.

Expand
표 6.727. 매개변수 요약
이름유형방향요약

device

VmMediatedDevice

in/Out

 

6.239.2. GET나열

구성된 템플릿 장치를 모두 나열합니다.

반환된 중재된 장치 목록의 순서는 보장되지 않습니다.

Expand
표 6.728. 매개변수 요약
이름유형방향요약

장치

VmMediatedDevice[]

Out

템플릿의 중재된 장치 목록입니다.

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 중재 장치의 최대 수를 설정합니다.

6.239.2.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.239.2.2. max

반환할 중재 장치의 최대 수를 설정합니다. 지정하지 않으면 미디어된 모든 장치가 반환됩니다.

6.240. TemplateNic

Expand
표 6.729. 메서드 요약
이름요약

get

 

제거

 

update

템플릿에 연결된 지정된 네트워크 인터페이스 카드를 업데이트합니다.

6.240.1. GET가져오기

Expand
표 6.730. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

nic

NIC

Out

 
6.240.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.240.2. DELETE제거

Expand
표 6.731. 매개변수 요약
이름유형방향요약

async

부울

in

제거가 비동기적으로 수행되어야 하는지 여부를 나타냅니다.

6.240.3. PUT업데이트

템플릿에 연결된 지정된 네트워크 인터페이스 카드를 업데이트합니다.

Expand
표 6.732. 매개변수 요약
이름유형방향요약

async

부울

in

업데이트를 비동기적으로 수행해야 하는지 여부를 나타냅니다.

nic

NIC

in/Out

 

6.241. TemplateNics

Expand
표 6.733. 메서드 요약
이름요약

add

새 네트워크 인터페이스 카드를 템플릿에 추가합니다.

list

템플릿의 NIC 목록을 반환합니다.

6.241.1. POST추가

새 네트워크 인터페이스 카드를 템플릿에 추가합니다.

Expand
표 6.734. 매개변수 요약
이름유형방향요약

nic

NIC

in/Out

 

6.241.2. GET나열

템플릿의 NIC 목록을 반환합니다.

반환된 NIC 목록의 순서는 보장되지 않습니다.

Expand
표 6.735. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 최대 NIC 수를 설정합니다.

nics

NIC []

Out

 
6.241.2.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.241.2.2. max

반환할 최대 NIC 수를 설정합니다. 지정하지 않으면 모든 NIC가 반환됩니다.

6.242. TemplateWatchdog

Expand
표 6.736. 메서드 요약
이름요약

get

 

제거

 

update

지정된 id로 식별된 템플릿의 워치독을 업데이트합니다.

6.242.1. GET가져오기

Expand
표 6.737. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

watchdog

Watchdog

Out

 
6.242.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.242.2. DELETE제거

Expand
표 6.738. 매개변수 요약
이름유형방향요약

async

부울

in

제거가 비동기적으로 수행되어야 하는지 여부를 나타냅니다.

6.242.3. PUT업데이트

지정된 id로 식별된 템플릿의 워치독을 업데이트합니다.

Expand
표 6.739. 매개변수 요약
이름유형방향요약

async

부울

in

업데이트를 비동기적으로 수행해야 하는지 여부를 나타냅니다.

watchdog

Watchdog

in/Out

 

6.243. TemplateWatchdogs

Expand
표 6.740. 메서드 요약
이름요약

add

지정된 id로 식별된 템플릿에 워치독을 추가합니다.

list

워치독 목록을 반환합니다.

6.243.1. POST추가

지정된 id로 식별된 템플릿에 워치독을 추가합니다.

Expand
표 6.741. 매개변수 요약
이름유형방향요약

watchdog

Watchdog

in/Out

 

6.243.2. GET나열

워치독 목록을 반환합니다.

반환된 워치독 목록의 순서는 보장되지 않습니다.

Expand
표 6.742. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 워치독의 최대 수를 설정합니다.

watchdogs

Watchdog[]

Out

 
6.243.2.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.243.2.2. max

반환할 워치독의 최대 수를 설정합니다. 지정하지 않으면 모든 워치독이 반환됩니다.

6.244. 템플릿

이 서비스는 시스템에서 사용 가능한 가상 시스템 템플릿을 관리합니다.

Expand
표 6.743. 메서드 요약
이름요약

add

새 템플릿을 생성합니다.

list

가상 머신 템플릿 목록을 반환합니다.

6.244.1. POST추가

새 템플릿을 생성합니다.

이를 위해서는 namevm 요소가 필요합니다. 가상 시스템을 식별하려면 vm.id 또는 vm.name 속성을 사용합니다. 예를 들어 식별자가 123 인 가상 머신에서 템플릿을 생성하려면 다음과 같은 요청을 보냅니다.

POST /ovirt-engine/api/templates

다음과 같이 요청 본문이 있는 경우:

<template>
  <name>mytemplate</name>
  <vm id="123"/>
</template>

버전 4.3부터 스냅샷에서 가상 머신 템플릿을 생성하기 위해 다음과 같이 요청 본문을 보냅니다.

<template>
  <name>mytemplate</name>
  <vm id="123">
    <snapshots>
      <snapshot id="456"/>
    </snapshots>
  </vm>
</template>

템플릿 디스크를 사용자 지정하여 원래 가상 시스템의 디스크와 몇 가지 특성을 다르게 만들 수 있습니다. 이를 위해 vm.disk_attachments 특성을 사용하여 원래 가상 시스템의 디스크 식별자와 변경하려는 특성을 지정합니다. 예를 들어 원래 가상 머신에 식별자 456 이 있는 디스크가 있고 해당 디스크의 경우 이름을 Copy On Writemydisk 형식으로 변경하고 스파스로 설정하려는 경우 다음과 같이 요청 본문을 보냅니다.

<template>
  <name>mytemplate</name>
  <vm id="123">
    <disk_attachments>
      <disk_attachment>
        <disk id="456">
          <name>mydisk</name>
          <format>cow</format>
          <sparse>true</sparse>
        </disk>
      </disk_attachment>
    </disk_attachments>
  </vm>
</template>

템플릿은 기존 템플릿의 하위 버전으로 생성할 수 있습니다. 이를 위해서는 새 템플릿의 namevm 속성과 새 템플릿 버전의 base_templateversion_name 속성이 필요합니다. base_templateversion_name 속성은 template 섹션에 묶인 version 섹션 내에 지정해야 합니다. id 또는 name 속성을 사용하여 가상 머신을 식별합니다.

<template>
  <name>mytemplate</name>
  <vm id="123"/>
  <version>
    <base_template id="456"/>
    <version_name>mytemplate_001</version_name>
  </version>
</template>

다음 두 가지 방법 중 하나로 템플릿의 대상 스토리지 도메인을 사용자 지정할 수 있습니다.

  1. 전역적으로, 요청 수준에서. 요청에 스토리지 도메인에서 생성할 원하는 디스크 첨부 파일이 나열되어야 합니다. 디스크 첨부 파일이 목록에 없으면 글로벌 스토리지 도메인 매개변수가 무시됩니다.

    <template>
      <name>mytemplate</name>
      <storage_domain id="123"/>
      <vm id="456">
        <disk_attachments>
          <disk_attachment>
            <disk id="789">
              <format>cow</format>
              <sparse>true</sparse>
            </disk>
          </disk_attachment>
        </disk_attachments>
      </vm>
    </template>
  2. 각 디스크 연결 단위. 각 디스크 연결에 필요한 스토리지 도메인을 지정합니다. 글로벌 스토리지 정의를 지정하면 디스크 연결 사양에 따라 스토리지 도메인이 재정의됩니다.

    <template>
      <name>mytemplate</name>
      <vm id="123">
        <disk_attachments>
          <disk_attachment>
            <disk id="456">
              <format>cow</format>
              <sparse>true</sparse>
              <storage_domains>
                 <storage_domain id="789"/>
              </storage_domains>
            </disk>
          </disk_attachment>
        </disk_attachments>
      </vm>
    </template>
Expand
표 6.744. 매개변수 요약
이름유형방향요약

clone_permissions

부울

in

가상 시스템의 권한을 템플릿에 복사해야 하는지 여부를 지정합니다.

seal

부울

in

템플릿을 봉인합니다.

template

템플릿

in/Out

템플릿 또는 템플릿 버전에 대한 정보입니다.

6.244.1.1. clone_permissions

가상 시스템의 권한을 템플릿에 복사해야 하는지 여부를 지정합니다.

이 선택적 매개 변수가 제공되고 해당 값이 true 인 경우 가상 시스템의 권한(데모된 항목이 아닌 직접)이 생성된 템플릿에 복사됩니다. 예를 들어, 권한을 복사하는 myvm 가상 머신에서 템플릿을 생성하려면 다음과 같은 요청을 보냅니다.

POST /ovirt-engine/api/templates?clone_permissions=true

다음과 같이 요청 본문이 있는 경우:

<template>
  <name>mytemplate<name>
  <vm>
    <name>myvm<name>
  </vm>
</template>
6.244.1.2. seal

템플릿을 봉인합니다.

이 선택적 매개 변수가 제공되며 해당 값이 true 이면 생성 후 템플릿이 봉인됩니다.

sealing은 파일 시스템의 모든 호스트 관련 구성을 삭제합니다. 즉, SSH 키, UDEV 규칙, MAC 주소, 시스템 ID, 호스트 이름 등을 지워서 템플릿을 사용하여 수동 조작 없이 여러 가상 시스템을 쉽게 생성할 수 있습니다.

현재 sealing은 Linux 운영 체제에서만 지원됩니다.

6.244.2. GET나열

가상 머신 템플릿 목록을 반환합니다.

예를 들어 다음과 같습니다.

GET /ovirt-engine/api/templates

는 가상 머신 및 가상 머신 템플릿 목록을 반환합니다.

반환된 템플릿 목록의 순서가 보장되지 않습니다.

Expand
표 6.745. 매개변수 요약
이름유형방향요약

case_sensitive

부울

in

검색 매개 변수를 사용하여 수행된 검색이 대소문자를 고려하여 수행해야 하는지 여부를 나타냅니다.

filter

부울

in

사용자의 권한에 따라 결과를 필터링해야 하는지 여부를 나타냅니다.

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 최대 템플릿 수를 설정합니다.

search

문자열

in

반환된 템플릿을 제한하는 데 사용되는 쿼리 문자열입니다.

템플릿

템플릿 []

Out

가상 머신 템플릿 목록입니다.

6.244.2.1. case_sensitive

검색 매개 변수를 사용하여 수행된 검색이 대소문자를 고려하여 수행해야 하는지 여부를 나타냅니다. 기본값은 true 입니다. 즉, 해당 케이스가 고려됩니다. 대소문자를 무시하고자 하는 경우 false 로 설정합니다.

6.244.2.2. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.244.2.3. max

반환할 최대 템플릿 수를 설정합니다. 지정하지 않으면 모든 템플릿이 반환됩니다.

6.245. UnmanagedNetwork

Expand
표 6.746. 메서드 요약
이름요약

get

 

제거

 

6.245.1. GET가져오기

Expand
표 6.747. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

network

UnmanagedNetwork

Out

 
6.245.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.245.2. DELETE제거

Expand
표 6.748. 매개변수 요약
이름유형방향요약

async

부울

in

제거가 비동기적으로 수행되어야 하는지 여부를 나타냅니다.

6.246. UnmanagedNetworks

Expand
표 6.749. 메서드 요약
이름요약

list

호스트의 관리되지 않는 네트워크 목록을 반환합니다.

6.246.1. GET나열

호스트의 관리되지 않는 네트워크 목록을 반환합니다.

반환된 네트워크 목록의 순서는 보장되지 않습니다.

Expand
표 6.750. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 최대 네트워크 수를 설정합니다.

networks

UnmanagedNetwork[]

Out

 
6.246.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.246.1.2. max

반환할 최대 네트워크 수를 설정합니다. 지정하지 않으면 모든 네트워크가 반환됩니다.

6.247. 사용자

시스템에서 사용자를 관리하는 서비스입니다. 이 서비스를 사용하여 사용자의 세부 정보를 얻거나 사용자를 제거합니다. 새로운 사용자를 추가하려면 사용자를 사용하십시오.

Expand
표 6.751. 메서드 요약
이름요약

get

시스템 사용자 정보를 가져옵니다.

제거

시스템 사용자를 제거합니다.

update

사용자에 대한 정보를 업데이트합니다.

6.247.1. GET가져오기

시스템 사용자 정보를 가져옵니다.

사용법:

GET /ovirt-engine/api/users/1234

는 사용자 정보를 반환합니다.

<user href="/ovirt-engine/api/users/1234" id="1234">
  <name>admin</name>
  <link href="/ovirt-engine/api/users/1234/sshpublickeys" rel="sshpublickeys"/>
  <link href="/ovirt-engine/api/users/1234/roles" rel="roles"/>
  <link href="/ovirt-engine/api/users/1234/permissions" rel="permissions"/>
  <link href="/ovirt-engine/api/users/1234/tags" rel="tags"/>
  <department></department>
  <domain_entry_id>23456</domain_entry_id>
  <email>user1@domain.com</email>
  <last_name>Lastname</last_name>
  <namespace>*</namespace>
  <principal>user1</principal>
  <user_name>user1@domain-authz</user_name>
  <domain href="/ovirt-engine/api/domains/45678" id="45678">
    <name>domain-authz</name>
  </domain>
</user>
Expand
표 6.752. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

user

사용자

Out

시스템 사용자

6.247.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.247.2. DELETE제거

시스템 사용자를 제거합니다.

사용법:

DELETE /ovirt-engine/api/users/1234
Expand
표 6.753. 매개변수 요약
이름유형방향요약

async

부울

in

제거가 비동기적으로 수행되어야 하는지 여부를 나타냅니다.

6.247.3. PUT업데이트

사용자에 대한 정보를 업데이트합니다.

user_options 필드만 업데이트할 수 있습니다.

예를 들어 사용자 옵션을 업데이트하려면 다음을 수행합니다.

PUT /ovirt-engine/api/users/123

다음과 같이 요청 본문이 있는 경우:

<user>
   <user_options>
      <property>
         <name>test</name>
         <value>["any","JSON"]</value>
      </property>
   </user_options>
</user>
중요

엔진의 버전 4.4.5 이후 이 작업은 더 이상 사용되지 않으며 이전 버전과의 호환성을 위해서만 유지됩니다. 이는 향후 삭제될 예정입니다. 대신 옵션 끝점을 사용하십시오.

Expand
표 6.754. 매개변수 요약
이름유형방향요약

user

사용자

in/Out

 

6.248. UserOption

Expand
표 6.755. 메서드 요약
이름요약

get

JSON 유형의 사용자 프로필 속성을 반환합니다.

제거

JSON 유형의 기존 속성을 삭제합니다.Delete an existing property of type JSON.

6.248.1. GET가져오기

JSON 유형의 사용자 프로필 속성을 반환합니다.

요청 예( 식별자가 123 이고 식별자가 456인 사용자의 경우):

GET /ovirt-engine/api/users/123/options/456

결과는 다음과 같은 XML 문서입니다.

  <user_option href="/ovirt-engine/api/users/123/options/456" id="456">
    <name>SomeName</name>
    <content>["any", "JSON"]</content>
    <user href="/ovirt-engine/api/users/123" id="123"/>
  </user_option>
Expand
표 6.756. 매개변수 요약
이름유형방향요약

옵션

UserOption

Out

 

6.248.2. DELETE제거

JSON 유형의 기존 속성을 삭제합니다.Delete an existing property of type JSON.

요청 예( 식별자가 123 이고 식별자가 456인 사용자의 경우):

DELETE /ovirt-engine/api/users/123/options/456

6.249. UserOptions

Expand
표 6.757. 메서드 요약
이름요약

add

JSON 유형의 새 사용자 프로필 속성을 추가합니다.

list

JSON 유형의 사용자 프로필 속성 목록을 반환합니다.

6.249.1. POST추가

JSON 유형의 새 사용자 프로필 속성을 추가합니다.

요청 예(ID가 123인 사용자의 경우):

POST /ovirt-engine/api/users/123/options

페이로드:

  <user_option>
    <name>SomeName</name>
    <content>["any", "JSON"]</content>
  </user_option>
Expand
표 6.758. 매개변수 요약
이름유형방향요약

옵션

UserOption

in/Out

 

6.249.2. GET나열

JSON 유형의 사용자 프로필 속성 목록을 반환합니다.

요청 예(ID가 123인 사용자의 경우):

GET /ovirt-engine/api/users/123/options

결과는 다음과 같은 XML 문서입니다.

<user_options>
  <user_option href="/ovirt-engine/api/users/123/options/456" id="456">
    <name>SomeName</name>
    <content>["any", "JSON"]</content>
    <user href="/ovirt-engine/api/users/123" id="123"/>
  </user_option>
</user_options>
Expand
표 6.759. 매개변수 요약
이름유형방향요약

options

UserOption[]

Out

 

6.250. 사용자

시스템에서 사용자를 관리하는 서비스입니다.

Expand
표 6.760. 메서드 요약
이름요약

add

디렉터리 서비스의 사용자를 추가합니다.

list

시스템의 모든 사용자를 나열합니다.

6.250.1. POST추가

디렉터리 서비스의 사용자를 추가합니다.

예를 들어 myextension-authz 권한 부여 공급자에서 myuser 사용자를 추가하려면 다음과 같은 요청을 보냅니다.

POST /ovirt-engine/api/users

다음과 같이 요청 본문이 있는 경우:

<user>
  <user_name>myuser@myextension-authz</user_name>
  <domain>
    <name>myextension-authz</name>
  </domain>
</user>

Active Directory를 사용하여 작업하는 경우 사용자 이름 UPN(사용자 계정 이름)과 권한 부여 공급자 이름을 전달해야 합니다. 버그 1147900 으로 인해 사용자의 UPN으로 설정된 기본 매개 변수도 제공해야 합니다.

예를 들어 myextension-authz 인증 공급자에서 UPN myuser@mysubdomain.mydomain.com 가 있는 사용자를 추가하려면 다음과 같이 요청 본문을 보냅니다.

<user>
  <principal>myuser@mysubdomain.mydomain.com</principal>
  <user_name>myuser@mysubdomain.mydomain.com@myextension-authz</user_name>
  <domain>
    <name>myextension-authz</name>
  </domain>
</user>
Expand
표 6.761. 매개변수 요약
이름유형방향요약

user

사용자

in/Out

 

6.250.2. GET나열

시스템의 모든 사용자를 나열합니다.

사용법:

GET /ovirt-engine/api/users

는 사용자 목록을 반환합니다.

<users>
  <user href="/ovirt-engine/api/users/1234" id="1234">
    <name>admin</name>
    <link href="/ovirt-engine/api/users/1234/sshpublickeys" rel="sshpublickeys"/>
    <link href="/ovirt-engine/api/users/1234/roles" rel="roles"/>
    <link href="/ovirt-engine/api/users/1234/permissions" rel="permissions"/>
    <link href="/ovirt-engine/api/users/1234/tags" rel="tags"/>
    <domain_entry_id>23456</domain_entry_id>
    <namespace>*</namespace>
    <principal>user1</principal>
    <user_name>user1@domain-authz</user_name>
    <domain href="/ovirt-engine/api/domains/45678" id="45678">
      <name>domain-authz</name>
    </domain>
  </user>
</users>

반환된 사용자 목록의 순서는 보장되지 않습니다.

Expand
표 6.762. 매개변수 요약
이름유형방향요약

case_sensitive

부울

in

검색 매개 변수를 사용하여 수행된 검색이 대소문자를 고려하여 수행해야 하는지 여부를 나타냅니다.

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 최대 사용자 수를 설정합니다.

search

문자열

in

반환된 사용자를 제한하는 데 사용되는 쿼리 문자열입니다.

사용자

사용자 []

Out

사용자 목록.

6.250.2.1. case_sensitive

검색 매개 변수를 사용하여 수행된 검색이 대소문자를 고려하여 수행해야 하는지 여부를 나타냅니다. 기본값은 true 입니다. 즉, 해당 케이스가 고려됩니다. 대소문자를 무시하고자 하는 경우 false 로 설정합니다.

6.250.2.2. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.250.2.3. max

반환할 최대 사용자 수를 설정합니다. 지정하지 않으면 모든 사용자가 반환됩니다.

6.251. VirtualFunctionAllowedNetwork

Expand
표 6.763. 메서드 요약
이름요약

get

 

제거

 

6.251.1. GET가져오기

Expand
표 6.764. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

network

네트워크

Out

 
6.251.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.251.2. DELETE제거

Expand
표 6.765. 매개변수 요약
이름유형방향요약

async

부울

in

제거가 비동기적으로 수행되어야 하는지 여부를 나타냅니다.

6.252. VirtualFunctionAllowedNetworks

Expand
표 6.766. 메서드 요약
이름요약

add

 

list

네트워크 목록을 반환합니다.

6.252.1. POST추가

Expand
표 6.767. 매개변수 요약
이름유형방향요약

network

네트워크

in/Out

 

6.252.2. GET나열

네트워크 목록을 반환합니다.

반환된 네트워크 목록의 순서는 보장되지 않습니다.

Expand
표 6.768. 매개변수 요약
이름유형방향요약

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 최대 네트워크 수를 설정합니다.

networks

Network[]

Out

 
6.252.2.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.252.2.2. max

반환할 최대 네트워크 수를 설정합니다. 지정하지 않으면 모든 네트워크가 반환됩니다.

6.253. Vm

Expand
표 6.769. 메서드 요약
이름요약

autopincpuandnumanodes

VM에 자동 CPU 및 NUMA 구성을 적용합니다.

cancelmigration

이 작업은 가상 시스템의 다른 물리적 호스트로의 마이그레이션을 중지합니다.

clone

 

commitsnapshot

가상 머신을 프리뷰된 스냅샷의 상태로 영구적으로 복원합니다.

detach

풀에서 가상 머신을 분리합니다.

export

가상 머신을 내보냅니다.

freezefilesystems

가상 머신 파일 시스템을 정지합니다.

get

가상 머신에 대한 설명을 검색합니다.

logon

자동 사용자 로그온을 시작하여 외부 콘솔에서 가상 머신에 액세스합니다.

maintenance

호스팅 엔진 가상 시스템에서 글로벌 유지 관리 모드를 설정합니다.

migrate

가상 머신을 다른 물리적 호스트로 마이그레이션합니다.

previewsnapshot

가상 머신을 임시로 스냅샷 상태로 복원합니다.

reboot

가상 머신에 재부팅 요청을 보냅니다.

제거

연결된 가상 디스크를 포함하여 가상 머신을 제거합니다.

localaddresses의 재정렬

 

reset

가상 머신에 재설정 요청을 보냅니다.

스크린샷

VM의 현재 상태 스크린샷을 캡처합니다.

shutdown

이 작업은 가상 머신에 종료 요청을 보냅니다.

start

가상 머신을 시작합니다.

중지

이 작업은 가상 시스템의 전원을 끄도록 강제 적용합니다.

일시 중단

이 작업은 가상 시스템 상태를 디스크에 저장하고 중지합니다.

thawfilesystems

가상 머신 파일 시스템 thaws.

ticket

가상 머신의 디스플레이에 액세스하기 위한 시간에 민감한 인증 토큰을 생성합니다.

undosnapshot

스냅샷을 미리 보기 전에 가상 머신을 해당 상태로 복원합니다.

update

지정된 가상 머신 ID의 시스템에서 가상 머신을 업데이트합니다.

6.253.1. autopincpuandnumanodes POST

VM에 자동 CPU 및 NUMA 구성을 적용합니다.

중요

엔진의 버전 4.5 이후 이 작업은 더 이상 사용되지 않으며 이전 버전과의 호환성을 위해서만 유지됩니다. 이는 향후 삭제될 예정입니다. 대신 PUT 다음 업데이트 작업을 사용하십시오.

요청의 예는 다음과 같습니다.

POST /ovirt-engine/api/vms/123/autopincpuandnumanodes

다음과 같이 요청 본문이 있는 경우:

<action>
  <optimize_cpu_settings>true</optimize_cpu_settings>
</action>
Expand
표 6.770. 매개변수 요약
이름유형방향요약

async

부울

in

분리 작업을 비동기적으로 수행해야 하는지 여부를 나타냅니다.Indicates if the detach action should be performed asynchronously.

optimize_cpu_settings

부울

in

자동 CPU 및 NUMA 구성이 적용되는 방법을 지정합니다.

6.253.1.1. optimize_cpu_settings

자동 CPU 및 NUMA 구성이 적용되는 방법을 지정합니다. true로 설정하면 VM 고정된 호스트 하드웨어에 맞게 CPU 토폴로지가 조정됩니다. 그렇지 않으면 VM CPU 토폴로지를 사용합니다.

6.253.2. 마이그레이션 취소 POST

이 작업은 가상 시스템의 다른 물리적 호스트로의 마이그레이션을 중지합니다.

POST /ovirt-engine/api/vms/123/cancelmigration

취소 마이그레이션 작업은 작업별 매개변수를 사용하지 않으므로 요청 본문에 빈 작업이 포함되어야 합니다.

<action/>
Expand
표 6.771. 매개변수 요약
이름유형방향요약

async

부울

in

마이그레이션이 비동기식으로 취소되었는지 여부를 나타냅니다.

6.253.3. clone POST

Expand
표 6.772. 매개변수 요약
이름유형방향요약

async

부울

in

복제를 비동기적으로 수행해야 하는지 여부를 나타냅니다.Indicates if the clone should be performed asynchronously.

discard_snapshots

부울

in

가상 머신이 축소된 스냅샷과 함께 복제되어야 하는 경우 discard_snapshots 매개변수를 사용합니다.

storage_domain

StorageDomain

in

가상 머신 디스크가 복사될 스토리지 도메인입니다.

vm

Vm

in

 
6.253.3.1. discard_snapshots

가상 머신이 축소된 스냅샷과 함께 복제되어야 하는 경우 discard_snapshots 매개변수를 사용합니다. 기본값은 true입니다.

6.253.4. commitsnapshot POST

가상 머신을 프리뷰된 스냅샷의 상태로 영구적으로 복원합니다.

자세한 내용은 preview_snapshot 작업을 참조하십시오.

Expand
표 6.773. 매개변수 요약
이름유형방향요약

async

부울

in

스냅샷을 비동기적으로 커밋해야 하는지 여부를 나타냅니다.

6.253.5. POST분리

풀에서 가상 머신을 분리합니다.

POST /ovirt-engine/api/vms/123/detach

분리 작업에서는 작업별 매개 변수를 사용하지 않으므로 요청 본문에 빈 작업이 포함되어야 합니다.

<action/>
Expand
표 6.774. 매개변수 요약
이름유형방향요약

async

부울

in

분리 작업을 비동기적으로 수행해야 하는지 여부를 나타냅니다.Indicates if the detach action should be performed asynchronously.

6.253.6. 내보내기 POST

가상 머신을 내보냅니다.

가상 머신을 내보내기 도메인으로 내보낼 수 있습니다. 예를 들어 가상 머신 123 을 내보내기 도메인 myexport 로 내보내려면 다음을 수행합니다.

POST /ovirt-engine/api/vms/123/export

다음과 같이 요청 본문이 있는 경우:

<action>
  <storage_domain>
    <name>myexport</name>
  </storage_domain>
  <exclusive>true</exclusive>
  <discard_snapshots>true</discard_snapshots>
</action>

엔진의 버전 4.2부터 가상 시스템을 OVA(가상 어플라이언스)로 내보낼 수도 있습니다. 예를 들어 가상 머신 123 을 호스트 myhost/home/ovirt/ 디렉터리에 있는 myvm.ova 라는 OVA 파일로 내보내려면 다음을 수행합니다.

POST /ovirt-engine/api/vms/123/export

다음과 같이 요청 본문이 있는 경우:

<action>
  <host>
    <name>myhost</name>
  </host>
  <directory>/home/ovirt</directory>
  <filename>myvm.ova</filename>
</action>
참고

내보내기 도메인에서 작업을 시도하기 전에 내보내기 작업이 완료되었는지 확인합니다.

Expand
표 6.775. 매개변수 요약
이름유형방향요약

async

부울

in

비동기적으로 내보내기를 수행해야 하는지 여부를 나타냅니다.Indicates whether the export should be performed asynchronously.

discard_snapshots

부울

in

가상 머신을 모든 스냅샷과 함께 내보내야 하는 경우 discard_snapshots 매개변수를 사용합니다.

exclusive

부울

in

가상 머신의 다른 복사본이 내보내기 도메인(override)에 이미 있는 경우에도 가상 머신을 내보내야 하는 경우 exclusive 매개 변수를 사용합니다.

storage_domain

StorageDomain

in

가상 머신을 내보낼 (export) 스토리지 도메인입니다.

6.253.7. freezefilesystems POST

가상 머신 파일 시스템을 정지합니다.

이 작업을 수행하면 실행 중인 가상 머신의 실시간 스냅샷을 만들 때 QEMU 게스트 에이전트를 사용하여 가상 머신의 파일 시스템이 중지됩니다. 일반적으로 이 작업은 관리자가 자동으로 수행하지만 OpenStack Volume(Cinder) 디스크를 사용하는 가상 시스템의 API를 사용하여 수동으로 실행해야 합니다.

예제:

POST /ovirt-engine/api/vms/123/freezefilesystems
<action/>
Expand
표 6.776. 매개변수 요약
이름유형방향요약

async

부울

in

freeze을 비동기적으로 수행해야 하는지 여부를 나타냅니다.Indicates if the freeze should be performed asynchronously.

6.253.8. GET가져오기

가상 머신에 대한 설명을 검색합니다.

Expand
표 6.777. 매개변수 요약
이름유형방향요약

all_content

부울

in

가상 머신의 모든 속성이 응답에 포함되어야 하는지 여부를 나타냅니다.

filter

부울

in

사용자의 권한에 따라 결과를 필터링해야 하는지 여부를 나타냅니다.

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

next_run

부울

in

반환된 결과가 현재 실행 중인 가상 머신을 나타내는지 또는 이미 수행된 수정 사항이 있는 가상 머신을 설명하는 경우 가상 머신이 다시 시작될 때만 적용됩니다.

ovf_as_ova

부울

in

해당 VM의 OVA 파일에 결과가 OVF를 노출해야 하는지 여부를 나타냅니다.

vm

Vm

Out

가상 머신에 대한 설명입니다.

6.253.8.1. all_content

가상 머신의 모든 속성이 응답에 포함되어야 하는지 여부를 나타냅니다.

기본적으로 다음 속성은 제외됩니다.

  • console
  • initialization.configuration.data - 가상 머신을 설명하는 OVF 문서입니다.
  • rng_source
  • soundcard
  • virtio_scsi

예를 들어 가상 머신 '123'의 전체 표시를 검색하려면 다음을 수행합니다.

GET /ovirt-engine/api/vms/123?all_content=true
참고

이러한 속성은 기본적으로 성능이 저하되므로 포함되지 않습니다. 이러한 속성은 거의 사용되지 않으며 데이터베이스에 추가 쿼리가 필요합니다. 필요한 경우에만 이 매개 변수를 사용하면 성능이 저하됩니다.

6.253.8.2. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.253.8.3. next_run

반환된 결과가 현재 실행 중인 가상 머신을 나타내는지 또는 이미 수행된 수정 사항이 있는 가상 머신을 설명하는 경우 가상 머신이 다시 시작될 때만 적용됩니다. 기본값은 false 입니다.

매개변수가 요청에 포함되어 있지만 값이 없는 경우 값이 true 인 것으로 가정합니다. 다음 요청:

GET /vms/{vm:id};next_run

값을 사용하는 것과 동일합니다.

GET /vms/{vm:id};next_run=true
6.253.8.4. ovf_as_ova

해당 VM의 OVA 파일에 결과가 OVF를 노출해야 하는지 여부를 나타냅니다. 가상 머신을 설명하는 OVF 문서입니다. 이 매개변수는 all_content=True가 설정된 경우에만 작동합니다. OVF가 initialization.configuration.data 에 표시됩니다.

예를 들어 다음과 같습니다.

GET /vms/{vm:id}?all_content=true&ovf_as_ova=true

6.253.9. logon POST

자동 사용자 로그온을 시작하여 외부 콘솔에서 가상 머신에 액세스합니다.

이 작업을 수행하려면 ovirt-guest-agent -gdm-pluginovirt-guest-agent-pam-module 패키지가 설치되어 가상 머신에서 실행 중이어야 합니다.

외부 콘솔에서 가상 시스템에 액세스하려면 가상 시스템에 적절한 사용자 권한이 필요합니다.

예를 들어 다음과 같습니다.

POST /ovirt-engine/api/vms/123/logon

요청 본문:

<action/>
Expand
표 6.778. 매개변수 요약
이름유형방향요약

async

부울

in

로그온이 비동기적으로 수행되어야 하는지 여부를 나타냅니다.Indicates if the logon should be performed asynchronously.

6.253.10. 유지 관리 POST

호스팅 엔진 가상 시스템에서 글로벌 유지 관리 모드를 설정합니다.

이 작업은 다른 가상 머신에는 영향을 미치지 않습니다.

예제:

POST /ovirt-engine/api/vms/123/maintenance
<action>
  <maintenance_enabled>true<maintenance_enabled/>
</action>
Expand
표 6.779. 매개변수 요약
이름유형방향요약

async

부울

in

전역 유지 관리 작업을 비동기적으로 수행해야 하는지 여부를 나타냅니다.Indicates if the global maintenance action should be performed asynchronously.

maintenance_enabled

부울

in

전역 유지 관리를 활성화하거나 비활성화해야 하는지 여부를 나타냅니다.

6.253.11. migrate POST

가상 머신을 다른 물리적 호스트로 마이그레이션합니다.

예제:

POST /ovirt-engine/api/vms/123/migrate

가상 머신을 마이그레이션할 특정 호스트를 지정하려면 다음을 수행합니다.

<action>
  <host id="2ab5e1da-b726-4274-bbf7-0a42b16a0fc3"/>
</action>
Expand
표 6.780. 매개변수 요약
이름유형방향요약

async

부울

in

마이그레이션을 비동기적으로 수행해야 하는지 여부를 나타냅니다.

cluster

Cluster

in

가상 머신이 마이그레이션할 클러스터를 지정합니다.

force

부울

in

가상 머신이 비migratable로 정의된 경우에도 가상 머신을 마이그레이션하도록 지정합니다.

host

호스트

in

가상 머신이 마이그레이션할 특정 호스트를 지정합니다.

migrate_vms_in_affinity_closure

부울

in

또한 동일한 호스트에서 실행 중인 이 가상 머신에서 이 가상 머신의 선호도 그룹을 긍정적으로 강제 적용하여 다른 모든 가상 시스템을 마이그레이션합니다.

6.253.11.1. cluster

가상 머신이 마이그레이션할 클러스터를 지정합니다. 이는 선택적 매개변수입니다. 기본적으로 가상 시스템은 동일한 클러스터 내의 다른 호스트로 마이그레이션됩니다.

주의

다른 클러스터로의 실시간 마이그레이션은 지원되지 않습니다. 마이그레이션을 시도하기 전에 대상 클러스터의 하드웨어 아키텍처 및 네트워크 아키텍처를 강력히 고려하십시오.

6.253.11.2. force

가상 머신이 비migratable로 정의된 경우에도 가상 머신을 마이그레이션하도록 지정합니다. 이는 선택적 매개변수입니다. 기본적으로 false 로 설정됩니다.

6.253.11.3. host

가상 머신이 마이그레이션할 특정 호스트를 지정합니다. 이는 선택적 매개변수입니다. 기본적으로 Red Hat Virtualization Manager는 동일한 클러스터 내에서 마이그레이션할 기본 호스트를 자동으로 선택합니다. API 사용자에게 특정 호스트가 필요한 경우 사용자는 id 또는 name 매개 변수를 사용하여 호스트를 지정할 수 있습니다.

6.253.11.4. migrate_vms_in_affinity_closure

또한 동일한 호스트에서 실행 중인 이 가상 머신에서 이 가상 머신의 선호도 그룹을 긍정적으로 강제 적용하여 다른 모든 가상 시스템을 마이그레이션합니다.

기본값은 false입니다.

6.253.12. previewsnapshot POST

가상 머신을 임시로 스냅샷 상태로 복원합니다.

스냅샷은 snapshot.id 매개 변수로 표시됩니다. 콘텐츠가 검사될 수 있도록 일시적으로 복원됩니다. 검사가 완료되면 commit_snapshot 메서드를 사용하여 가상 머신의 상태를 영구적으로 수행하거나 undo_snapshot 방법을 사용하여 삭제할 수 있습니다.

Expand
표 6.781. 매개변수 요약
이름유형방향요약

async

부울

in

미리 비동기적으로 수행해야 하는지 여부를 나타냅니다.Indicates if the preview should be performed asynchronously.

디스크

Disk[]

in

스냅샷의 프리뷰에 포함된 디스크를 지정합니다.

리스

StorageDomainLease

in

스냅샷 프리뷰에서 사용할 리스 스토리지 도메인 ID를 지정합니다.

restore_memory

부울

in

 

snapshot

스냅샷

in

 

vm

Vm

in

 
6.253.12.1. 디스크

스냅샷의 프리뷰에 포함된 디스크를 지정합니다.

각 disk 매개 변수에 대해 image_id 를 지정해야 합니다.

예를 들어 식별자 111 과 해당 image_id222 인 디스크를 포함하는 식별자(4656)가 있는 스냅샷을 미리 보려면 다음과 같이 요청을 보냅니다.

POST /ovirt-engine/api/vms/123/previewsnapshot

요청 본문:

<action>
  <disks>
    <disk id="111">
      <image_id>222</image_id>
    </disk>
  </disks>
  <snapshot id="456"/>
</action>
6.253.12.2. 리스

스냅샷 프리뷰에서 사용할 리스 스토리지 도메인 ID를 지정합니다. lease 매개 변수가 전달되지 않으면 프리뷰된 스냅샷 리스 스토리지 도메인이 사용됩니다. 리스 매개 변수가 빈 스토리지 도메인 매개변수로 전달되면 스냅샷 프리뷰에 리스가 사용되지 않습니다. 스토리지 도메인 매개변수를 사용하여 리스 매개 변수를 전달하면 스토리지 도메인 ID는 가상 머신 스냅샷 중 하나에 속하는 리스 도메인 ID 중 하나일 수 있습니다. 이는 기본적으로 null로 설정된 선택적 매개변수입니다.

6.253.13. POST재부팅

가상 머신에 재부팅 요청을 보냅니다.

예를 들어 다음과 같습니다.

POST /ovirt-engine/api/vms/123/reboot

재부팅 작업에서는 작업별 매개 변수를 사용하지 않으므로 요청 본문에 빈 작업이 포함되어야 합니다.

<action/>

백업이 실행 중인 경우에도 VM을 재부팅하려면 'force' 요소를 포함해야 합니다.

예를 들어 가상 머신 123 을 강제로 재부팅하려면 다음을 수행합니다.

POST /ovirt-engine/api/vms/123/reboot
<action>
    <force>true</force>
</action>
Expand
표 6.782. 매개변수 요약
이름유형방향요약

async

부울

in

재부팅이 비동기적으로 수행되어야 하는지 여부를 나타냅니다.

force

부울

in

백업이 실행 중인 경우에도 VM을 강제 재부팅해야 하는지 여부를 나타냅니다.

6.253.14. DELETE제거

연결된 가상 디스크를 포함하여 가상 머신을 제거합니다.

예를 들어 식별자가 123 인 가상 머신을 제거하려면 다음을 수행합니다.

DELETE /ovirt-engine/api/vms/123
Expand
표 6.783. 매개변수 요약
이름유형방향요약

async

부울

in

제거가 비동기적으로 수행되어야 하는지 여부를 나타냅니다.

detach_only

부울

in

연결된 가상 디스크를 먼저 분리하고 제거하는 대신 보존해야 하는지 여부를 나타냅니다.

force

부울

in

가상 머신이 제거되어야 하는지 여부를 나타냅니다.

6.253.14.1. force

가상 머신이 제거되어야 하는지 여부를 나타냅니다.

이 플래그를 true로 설정하지 않으면 디스크 이미지가 잠겼은 가상 머신과 가상 머신을 제거할 수 없습니다.

6.253.15. reordermacaddresses POST

Expand
표 6.784. 매개변수 요약
이름유형방향요약

async

부울

in

비동기적으로 작업을 수행해야 하는지 여부를 나타냅니다.Indicates whether the action should be performed asynchronously.

6.253.16. POST재설정

가상 머신에 재설정 요청을 보냅니다.

예를 들어 다음과 같습니다.

POST /ovirt-engine/api/vms/123/reset

reset 작업에서는 동작 특정 매개변수를 사용하지 않으므로 요청 본문에 빈 작업이 포함되어야 합니다.

<action/>
Expand
표 6.785. 매개변수 요약
이름유형방향요약

async

부울

in

재설정이 비동기적으로 수행되어야 하는지 여부를 나타냅니다.

6.253.17. 스크린샷 POST

VM의 현재 상태 스크린샷을 캡처합니다.

예를 들어 다음과 같습니다.

POST /ovirt-engine/api/vms/123/screenshot

스크린샷 작업은 작업별 매개 변수를 사용하지 않으므로 요청 본문에 빈 작업이 포함되어야 합니다.

<action/>

6.253.18. shutdown POST

이 작업은 가상 머신에 종료 요청을 보냅니다.

예를 들어 다음과 같습니다.

POST /ovirt-engine/api/vms/123/shutdown

종료 작업에서는 작업별 매개 변수를 사용하지 않으므로 요청 본문에 빈 작업이 포함되어야 합니다.

<action/>

백업이 실행 중인 경우에도 VM을 종료하려면 'force' 요소를 포함해야 합니다.

예를 들어 가상 머신 123 을 강제 종료하려면 다음을 수행합니다.

POST /ovirt-engine/api/vms/123/shutdown
<action>
    <force>true</force>
</action>
Expand
표 6.786. 매개변수 요약
이름유형방향요약

async

부울

in

종료를 비동기적으로 수행해야 하는지 여부를 나타냅니다.Indicates if the shutdown should be performed asynchronously.

force

부울

in

백업이 실행 중인 경우에도 VM이 강제 종료되어야 하는지 여부를 나타냅니다.

reason

문자열

in

가상 머신이 중지된 이유입니다.

6.253.18.1. reason

가상 머신이 중지된 이유입니다. 선택적으로 가상 머신을 종료할 때 사용자가 설정합니다.

6.253.19. POST시작

가상 머신을 시작합니다.

가상 환경이 완료되고 가상 머신에 작동하는 데 필요한 모든 구성 요소가 포함된 경우 이를 시작할 수 있습니다.

이 예에서는 가상 머신을 시작합니다.

POST /ovirt-engine/api/vms/123/start

요청 본문을 사용하는 경우:

<action/>
Expand
표 6.787. 매개변수 요약
이름유형방향요약

async

부울

in

시작 작업을 비동기적으로 수행해야 하는지 여부를 나타냅니다.Indicates if the start action should be performed asynchronously.

authorized_key

AuthorizedKey

in

 

filter

부울

in

사용자의 권한에 따라 결과를 필터링해야 하는지 여부를 나타냅니다.

pause

부울

in

true 로 설정하면 일시 정지 모드에서 가상 머신을 시작합니다.

use_cloud_init

부울

in

true 로 설정하면 초기화 유형이 cloud-init 로 설정됩니다.

use_ignition

부울

in

true 로 설정하면 초기화 유형이 Ignition 으로 설정됩니다.

use_initialization

부울

in

true 로 설정하면 VM의 OS에 의해 초기화 유형이 설정됩니다.

use_sysprep

부울

in

true 로 설정하면 초기화 유형이 Sysprep 로 설정됩니다.

vm

Vm

in

이 특정 실행에 대한 가상 머신 정의입니다.

volatile

부울

in

게스트 시작 재부팅의 경우에도 이 실행 구성이 삭제됨을 나타냅니다.

6.253.19.1. pause

true 로 설정하면 일시 정지 모드에서 가상 머신을 시작합니다. 기본값은 false입니다.

6.253.19.2. use_cloud_init

true 로 설정하면 초기화 유형이 cloud-init 로 설정됩니다. 기본값은 false입니다. 자세한 내용은 cloud-init 설명서를 참조하십시오.

6.253.19.3. use_ignition

true 로 설정하면 초기화 유형이 Ignition 으로 설정됩니다. 기본값은 false입니다. 자세한 내용은 Ignition 설명서를 참조하십시오.

6.253.19.4. use_initialization

true 로 설정하면 VM의 OS에 의해 초기화 유형이 설정됩니다. Windows는 Sysprep, Linux를 cloud-init 로, RedHat CoreOS를 Ignition 으로 설정합니다. initialization-types 중 하나를 명시적으로 설정(useCloudInit, useSysprep 또는 useIgnition)하는 경우 우선 순위가 지정되고 이 플래그가 무시됩니다. 기본값은 false입니다.

6.253.19.5. use_sysprep

true 로 설정하면 초기화 유형이 Sysprep 로 설정됩니다. 기본값은 false입니다. 자세한 내용은 Sysprep 을 참조하십시오.

6.253.19.6. vm

이 특정 실행에 대한 가상 머신 정의입니다.

예를 들어 다음과 같습니다.

<action>
  <vm>
    <os>
      <boot>
        <devices>
          <device>cdrom</device>
        </devices>
      </boot>
    </os>
  </vm>
</action>

이렇게 하면 부팅 장치가 이 특정 시작에 대해서만 CDROM으로 설정됩니다. 가상 시스템의 전원이 꺼지면 이 정의가 복원됩니다.

6.253.19.7. volatile

게스트 시작 재부팅의 경우에도 이 실행 구성이 삭제됨을 나타냅니다. 기본값은 false입니다.

6.253.20. POST중지

이 작업은 가상 시스템의 전원을 끄도록 강제 적용합니다.

예를 들어 다음과 같습니다.

POST /ovirt-engine/api/vms/123/stop

중지 작업은 작업별 매개 변수를 사용하지 않으므로 요청 본문에 빈 작업이 포함되어야 합니다.

<action/>

백업이 실행 중인 경우에도 VM을 중지하려면 'force' 요소를 포함해야 합니다.

예를 들어 가상 머신 123 을 강제로 중지하려면 다음을 수행합니다.

POST /ovirt-engine/api/vms/123/stop
<action>
    <force>true</force>
</action>
Expand
표 6.788. 매개변수 요약
이름유형방향요약

async

부울

in

중지 작업을 비동기적으로 수행해야 하는지 여부를 나타냅니다.Indicates if the stop action should be performed asynchronously.

force

부울

in

백업이 실행 중인 경우에도 VM을 중지해야 하는지 여부를 나타냅니다.

reason

문자열

in

가상 머신이 중지된 이유입니다.

6.253.20.1. reason

가상 머신이 중지된 이유입니다. 선택적으로 가상 머신을 종료할 때 사용자가 설정합니다.

6.253.21. POST일시 중단

이 작업은 가상 시스템 상태를 디스크에 저장하고 중지합니다. 일시 중단된 가상 시스템을 시작하고 시작 작업으로 가상 시스템 상태를 복원합니다.

예를 들어 다음과 같습니다.

POST /ovirt-engine/api/vms/123/suspend

일시 중지 작업은 작업별 매개 변수를 사용하지 않으므로 요청 본문에 빈 작업이 포함되어야 합니다.

<action/>
Expand
표 6.789. 매개변수 요약
이름유형방향요약

async

부울

in

일시 중단 작업을 비동기적으로 수행해야 하는지 여부를 나타냅니다.Indicates if the suspend action should be performed asynchronously.

6.253.22. thawfilesystems POST

가상 머신 파일 시스템 thaws.

이 작업은 실행 중인 가상 머신의 실시간 스냅샷을 만들 때 QEMU 게스트 에이전트를 사용하여 가상 머신의 파일 시스템을 충돌합니다. 일반적으로 이 작업은 관리자가 자동으로 수행하지만 OpenStack Volume(Cinder) 디스크를 사용하는 가상 시스템의 API를 사용하여 수동으로 실행해야 합니다.

예제:

POST /api/vms/123/thawfilesystems
<action/>
Expand
표 6.790. 매개변수 요약
이름유형방향요약

async

부울

in

thaw 파일 시스템 작업을 비동기적으로 수행해야 하는지 여부를 나타냅니다.

6.253.23. 티켓 POST

가상 머신의 디스플레이에 액세스하기 위한 시간에 민감한 인증 토큰을 생성합니다.

예를 들어 다음과 같습니다.

POST /ovirt-engine/api/vms/123/ticket

클라이언트 제공 작업에는 필요한 티켓 값 및/또는 만료 시간(초)이 포함됩니다.

응답은 실제 티켓 값과 사용된 만료 값을 지정합니다.

<action>
  <ticket>
    <value>abcd12345</value>
    <expiry>120</expiry>
  </ticket>
</action>
중요

가상 머신이 하나의 그래픽 프로토콜만 지원하도록 구성된 경우 생성된 인증 토큰이 해당 프로토콜에 유효합니다. 그러나 가상 머신이 여러 프로토콜, VNC 및 SPICE를 지원하도록 구성된 경우 SPICE 프로토콜에만 인증 토큰이 유효합니다.

예를 들어 VNC의 경우 특정 프로토콜에 대한 인증 토큰을 얻으려면 요청을 전송하여 가상 시스템의 그래픽 콘솔을 관리하는 서비스 티켓 방법을 사용합니다.

POST /ovirt-engine/api/vms/123/graphicsconsoles/456/ticket
Expand
표 6.791. 매개변수 요약
이름유형방향요약

async

부울

in

티켓 생성이 비동기적으로 수행되어야 하는지 여부를 나타냅니다.

ticket

티켓

in/Out

 

6.253.24. undosnapshot POST

스냅샷을 미리 보기 전에 가상 머신을 해당 상태로 복원합니다.

자세한 내용은 preview_snapshot 작업을 참조하십시오.

Expand
표 6.792. 매개변수 요약
이름유형방향요약

async

부울

in

실행 취소 스냅샷 작업을 비동기적으로 수행해야 하는지 여부를 나타냅니다.

6.253.25. PUT업데이트

지정된 가상 머신 ID의 시스템에서 가상 머신을 업데이트합니다.

Expand
표 6.793. 매개변수 요약
이름유형방향요약

async

부울

in

업데이트를 비동기적으로 수행해야 하는지 여부를 나타냅니다.

next_run

부울

in

업데이트를 가상 머신에 즉시 적용해야 하는지 또는 가상 머신을 재시작할 때만 적용해야 하는지 여부를 나타냅니다.

vm

Vm

in/Out

 
6.253.25.1. next_run

업데이트를 가상 머신에 즉시 적용해야 하는지 또는 가상 머신을 재시작할 때만 적용해야 하는지 여부를 나타냅니다. 기본값은 false 이므로 기본적으로 변경 사항이 즉시 적용됩니다.

6.254. VmApplication

가상 머신에 설치된 애플리케이션에 대한 정보를 제공하는 서비스입니다.

Expand
표 6.794. 메서드 요약
이름요약

get

애플리케이션에 대한 정보를 반환합니다.

6.254.1. GET가져오기

애플리케이션에 대한 정보를 반환합니다.

Expand
표 6.795. 매개변수 요약
이름유형방향요약

애플리케이션

애플리케이션

Out

애플리케이션에 대한 정보입니다.

filter

부울

in

사용자의 권한에 따라 결과를 필터링해야 하는지 여부를 나타냅니다.

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

6.254.1.1. 애플리케이션

애플리케이션에 대한 정보입니다.

정보는 애플리케이션 이름 (버전과 같은 추가 정보를 포함할 수도 있는 임의의 문자열) 및 가상 머신을 식별하는 vm 특성을 포함하는 name 속성으로 구성됩니다.

예를 들면 다음과 같은 요청입니다.

GET /ovirt-engine/api/vms/123/applications/789

다음과 같은 정보를 반환할 수 있습니다.

<application href="/ovirt-engine/api/vms/123/applications/789" id="789">
  <name>ovirt-guest-agent-common-1.0.12-3.el7</name>
  <vm href="/ovirt-engine/api/vms/123" id="123"/>
</application>
6.254.1.2. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.255. VmApplications

가상 머신에 설치된 애플리케이션에 대한 정보를 제공하는 서비스입니다.

Expand
표 6.796. 메서드 요약
이름요약

list

가상 머신에 설치된 애플리케이션 목록을 반환합니다.

6.255.1. GET나열

가상 머신에 설치된 애플리케이션 목록을 반환합니다.

반환된 애플리케이션 목록의 순서는 보장되지 않습니다.

Expand
표 6.797. 매개변수 요약
이름유형방향요약

애플리케이션

Application []

Out

가상 머신에 설치된 애플리케이션 목록입니다.

filter

부울

in

사용자의 권한에 따라 결과를 필터링해야 하는지 여부를 나타냅니다.

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 최대 애플리케이션 수를 설정합니다.

6.255.1.1. 애플리케이션

가상 머신에 설치된 애플리케이션 목록입니다.

예를 들면 다음과 같은 요청입니다.

GET /ovirt-engine/api/vms/123/applications/

다음과 같은 목록을 반환할 수 있습니다.

<applications>
  <application href="/ovirt-engine/api/vms/123/applications/456" id="456">
    <name>kernel-3.10.0-327.36.1.el7</name>
    <vm href="/ovirt-engine/api/vms/123" id="123"/>
  </application>
  <application href="/ovirt-engine/api/vms/123/applications/789" id="789">
    <name>ovirt-guest-agent-common-1.0.12-3.el7</name>
    <vm href="/ovirt-engine/api/vms/123" id="123"/>
  </application>
</applications>
6.255.1.2. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.255.1.3. max

반환할 최대 애플리케이션 수를 설정합니다. 지정하지 않으면 모든 애플리케이션이 반환됩니다.

6.256. VmBackup

가상 시스템의 백업을 관리하는 서비스입니다.

Expand
표 6.798. 메서드 요약
이름요약

완료

가상 머신 백업 엔티티를 종료합니다.

get

가상 머신 백업에 대한 정보를 반환합니다.

6.256.1. 완료 POST

가상 머신 백업 엔티티를 종료합니다.

최종 백업, 리소스 잠금 해제 및 정리 수행. id '123'을 사용하여 가상 머신을 종료하고 ID가 '456'인 백업이 다음과 같이 요청을 보내려면 다음을 수행합니다.

POST /ovirt-engine/api/vms/123/backups/456/finalize

다음과 같이 요청 본문을 사용합니다.

<action />

6.256.2. GET가져오기

가상 머신 백업에 대한 정보를 반환합니다.

Expand
표 6.799. 매개변수 요약
이름유형방향요약

Backup

Backup

Out

가상 머신 백업 엔터티에 대한 정보입니다.

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

6.256.2.1. Backup

가상 머신 백업 엔터티에 대한 정보입니다.

<backups>
  <backup id="backup-uuid">
    <from_checkpoint_id>previous-checkpoint-uuid</from_checkpoint_id>
    <link href="/ovirt-engine/api/vms/vm-uuid/backups/backup-uuid/disks" rel="disks"/>
    <status>initializing</status>
    <creation_date>
 </backup>
</backups>
6.256.2.2. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.257. VmBackupDisk

Expand
표 6.800. 메서드 요약
이름요약

get

디스크의 설명을 검색합니다.

6.257.1. GET가져오기

디스크의 설명을 검색합니다.

Expand
표 6.801. 매개변수 요약
이름유형방향요약

disk

디스크

Out

디스크에 대한 설명입니다.

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

6.257.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.258. VmBackupDisks

Expand
표 6.802. 메서드 요약
이름요약

list

백업의 디스크 목록을 반환합니다.

6.258.1. GET나열

백업의 디스크 목록을 반환합니다.

Expand
표 6.803. 매개변수 요약
이름유형방향요약

디스크

Disk[]

Out

검색된 디스크 목록입니다.

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 최대 디스크 수를 설정합니다.

6.258.1.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.258.1.2. max

반환할 최대 디스크 수를 설정합니다. 지정하지 않으면 모든 디스크가 반환됩니다.

6.259. VmBackups

가상 머신의 백업을 나열합니다.

Expand
표 6.804. 메서드 요약
이름요약

add

가상 머신에 새 백업 엔티티를 추가합니다.

list

가상 머신 백업 목록입니다.

6.259.1. POST추가

가상 머신에 새 백업 엔티티를 추가합니다.

예를 들어 checkpoint id previous-checkpoint-uuid 이므로 가상 머신의 새로운 증분 백업을 시작하려면 다음과 같은 요청을 보냅니다.

POST /ovirt-engine/api/vms/123/backups

다음과 같이 요청 본문이 있는 경우:

<backup>
  <from_checkpoint_id>previous-checkpoint-uuid</from_checkpoint_id>
  <disks>
      <disk id="disk-uuid" />
      ...
  </disks>
</backup>

응답 본문:

<backup id="backup-uuid">
    <from_checkpoint_id>previous-checkpoint-uuid</from_checkpoint_id>
    <to_checkpoint_id>new-checkpoint-uuid</to_checkpoint_id>
    <disks>
        <disk id="disk-uuid" />
        ...
        ...
    </disks>
    <status>initializing</status>
    <creation_date>
</backup>

생성된 백업의 ID를 제공하려면 다음과 같은 요청을 보냅니다.

POST /ovirt-engine/api/vms/123/backups

다음과 같이 요청 본문이 있는 경우:

<backup id="backup-uuid">
  <from_checkpoint_id>previous-checkpoint-uuid</from_checkpoint_id>
  <disks>
      <disk id="disk-uuid" />
      ...
  </disks>
</backup>
Expand
표 6.805. 매개변수 요약
이름유형방향요약

Backup

Backup

in/Out

가상 머신 백업 엔티티에 대한 정보입니다.

require_consistency

부울

in

VM이 정지되지 않은 경우 백업이 실패하는지 여부를 나타냅니다.

use_active

부울

in

백업을 수행할 활성 볼륨을 사용할지 여부를 나타냅니다.

6.259.1.1. require_consistency

VM이 정지되지 않은 경우 백업이 실패하는지 여부를 나타냅니다.

VM을 중지하지 못한 경우 requireConsistency=True VM 백업이 실패합니다.

REST API 호출은 다음과 같아야 합니다.

POST /ovirt-engine/api/vms/123/backups?require_consistency=true

requireConsistency 플래그의 기본값은 false 입니다.

6.259.1.2. use_active

백업을 수행할 활성 볼륨을 사용할지 여부를 나타냅니다.

useActive=False인 경우 백업 작업에 대한 스냅샷이 생성됩니다.

REST API 호출은 다음과 같아야 합니다.

POST /ovirt-engine/api/vms/123/backups?use_active=false

useActive 플래그의 기본값은 false 입니다.

6.259.2. GET나열

가상 머신 백업 목록입니다.

Expand
표 6.806. 매개변수 요약
이름유형방향요약

백업

백업 []

Out

가상 머신 백업 엔터티에 대한 정보입니다.

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 가상 머신 백업의 최대 수를 설정합니다.

6.259.2.1. 백업

가상 머신 백업 엔터티에 대한 정보입니다.

<backups>
  <backup id="backup-uuid">
    <from_checkpoint_id>previous-checkpoint-uuid</from_checkpoint_id>
    <disks>
      <disk id="disk-uuid" />
      ...
      ...
    </disks>
    <status>initiailizing</status>
    <creation_date>
 </backup>
</backups>
6.259.2.2. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.259.2.3. max

반환할 가상 머신 백업의 최대 수를 설정합니다. 지정하지 않으면 모든 가상 머신 백업이 반환됩니다.

6.260. VmCdrom

가상 머신의 CDROM 장치를 관리합니다.

디스크 변경 및 제거는 항상 업데이트 방법을 사용하여 파일 속성의 값을 변경합니다.

Expand
표 6.807. 메서드 요약
이름요약

get

이 CDROM 장치에 대한 정보를 반환합니다.

update

이 CDROM 장치에 대한 정보를 업데이트합니다.

6.260.1. GET가져오기

이 CDROM 장치에 대한 정보를 반환합니다.

정보는 CDROM 장치, 가상 머신, 선택적으로 삽입된 디스크에 대한 참조가 포함된 cdrom 속성으로 구성됩니다.

디스크가 삽입되면 file 속성에 ISO 이미지에 대한 참조가 포함됩니다.

<cdrom href="..." id="00000000-0000-0000-0000-000000000000">
  <file id="mycd.iso"/>
  <vm href="/ovirt-engine/api/vms/123" id="123"/>
</cdrom>

디스크가 삽입되지 않으면 file 속성이 보고되지 않습니다.

<cdrom href="..." id="00000000-0000-0000-0000-000000000000">
  <vm href="/ovirt-engine/api/vms/123" id="123"/>
</cdrom>
Expand
표 6.808. 매개변수 요약
이름유형방향요약

cdrom

CDROM

Out

CDROM 장치에 대한 정보

current

부울

in

작업에서 현재 실행 중인 가상 머신에 대한 정보를 반환해야 하는지 여부를 나타냅니다.

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

6.260.1.1. current

작업에서 현재 실행 중인 가상 머신에 대한 정보를 반환해야 하는지 여부를 나타냅니다. 이 매개변수는 선택 사항이며 기본값은 false 입니다.

6.260.1.2. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.260.2. PUT업데이트

이 CDROM 장치에 대한 정보를 업데이트합니다.

파일 속성의 값을 변경하여 디스크를 변경하거나 제거할 수 있습니다. 예를 들어, 디스크를 삽입하거나 변경하려면 다음과 같은 요청을 보냅니다.

PUT /ovirt-engine/api/vms/123/cdroms/00000000-0000-0000-0000-000000000000

본문에는 file 속성에 대한 새 값이 포함되어야 합니다.

<cdrom>
  <file id="mycd.iso"/>
</cdrom>

id 속성의 값은 이 예제의 mycd.iso 값은 연결된 ISO 스토리지 도메인에서 사용 가능한 파일에 해당해야 합니다.

디스크에 빈 ID가 있는 파일을 사용하려면 다음을 수행하십시오.

<cdrom>
  <file id=""/>
</cdrom>

기본적으로 위의 작업은 다음 부팅 후 가상 머신에 표시되는 디스크를 영구적으로 변경하지만 현재 실행 중인 가상 머신에는 영향을 미치지 않습니다. 현재 실행 중인 가상 머신에 표시되는 디스크를 변경하려면 current=true 매개 변수를 추가합니다. 예를 들어 현재 디스크를 비우면 다음과 같은 요청을 보냅니다.

PUT /ovirt-engine/api/vms/123/cdroms/00000000-0000-0000-0000-000000000000?current=true

다음과 같이 요청 본문이 있는 경우:

<cdrom>
  <file id=""/>
</cdrom>
중요

current=true 매개 변수를 사용한 변경 사항은 유지되지 않으므로 가상 머신이 재부팅된 후에는 적용되지 않습니다.

Expand
표 6.809. 매개변수 요약
이름유형방향요약

cdrom

CDROM

in/Out

CDROM 장치에 대한 정보

current

부울

in

현재 실행 중인 가상 머신 또는 다음 부팅 후 가상 머신에 업데이트가 적용되는지 여부를 나타냅니다.

6.260.2.1. current

현재 실행 중인 가상 머신 또는 다음 부팅 후 가상 머신에 업데이트가 적용되는지 여부를 나타냅니다. 이 매개변수는 선택 사항이며 기본값은 false 이며 기본값은 false이며 기본적으로 업데이트는 다음 부팅 후에만 적용됩니다.

6.261. VmCdroms

가상 머신의 CDROM 장치를 관리합니다.

현재 가상 시스템에는 정확히 하나의 CDROM 장치가 있습니다. 새 장치를 추가할 수 없으며 기존 장치를 제거할 수 없으므로 추가 또는 제거 방법이 없습니다. CDROM 디스크 변경 및 제거는 CDROM 장치를 관리하는 서비스 업데이트 방법으로 수행됩니다.

Expand
표 6.810. 메서드 요약
이름요약

add

지정된 id로 식별되는 가상 머신에 cdrom을 추가합니다.

list

가상 머신의 CDROM 장치 목록을 반환합니다.

6.261.1. POST추가

지정된 id로 식별되는 가상 머신에 cdrom을 추가합니다.

Expand
표 6.811. 매개변수 요약
이름유형방향요약

cdrom

CDROM

in/Out

 

6.261.2. GET나열

가상 머신의 CDROM 장치 목록을 반환합니다.

반환된 CD-ROM 장치 목록의 순서는 보장되지 않습니다.

Expand
표 6.812. 매개변수 요약
이름유형방향요약

cdroms

Cdrom[]

Out

가상 머신의 CDROM 장치 목록입니다.

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

max

정수

in

반환할 CDROM의 최대 수를 설정합니다.

6.261.2.1. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.261.2.2. max

반환할 CDROM의 최대 수를 설정합니다. 지정하지 않으면 모든 CDROM이 반환됩니다.

6.262. VmCheckpoint

가상 머신의 검사점을 관리하는 서비스입니다.

Expand
표 6.813. 메서드 요약
이름요약

get

가상 머신 검사점에 대한 정보를 반환합니다.

제거

가상 머신 검사점 엔터티를 제거합니다.

6.262.1. GET가져오기

가상 머신 검사점에 대한 정보를 반환합니다.

Expand
표 6.814. 매개변수 요약
이름유형방향요약

checkpoint

checkpoint

Out

가상 머신 검사점 엔티티에 대한 정보입니다.

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.

6.262.1.1. checkpoint

가상 머신 검사점 엔티티에 대한 정보입니다.

<checkpoint id="checkpoint-uuid">
 <link href="/ovirt-engine/api/vms/vm-uuid/checkpoints/checkpoint-uuid/disks" rel="disks"/>
 <parent_id>parent-checkpoint-uuid</parent_id>
 <creation_date>xxx</creation_date>
 <vm href="/ovirt-engine/api/vms/vm-uuid" id="vm-uuid"/>
</checkpoint>
6.262.1.2. 팔로우

따라야 할 내부 링크를 나타냅니다. 이러한 링크에서 참조하는 오브젝트는 현재 요청의 일부로 가져옵니다. 자세한 내용은 여기를 참조하십시오.

6.262.2. DELETE제거

가상 머신 검사점 엔터티를 제거합니다.

libvirt 및 데이터베이스에서 검사점을 제거합니다.

Expand
표 6.815. 매개변수 요약
이름유형방향요약

async

부울

in

제거가 비동기적으로 수행되어야 하는지 여부를 나타냅니다.

6.263. VmCheckpointDisk

Expand
표 6.816. 메서드 요약
이름요약

get

디스크의 설명을 검색합니다.

6.263.1. GET가져오기

디스크의 설명을 검색합니다.

Expand
표 6.817. 매개변수 요약
이름유형방향요약

disk

디스크

Out

디스크에 대한 설명입니다.

팔로우

문자열

in

따라야 할 내부 링크를 나타냅니다.