computing / Client / describe_dhcp_options

describe_dhcp_options

computing.Client.describe_dhcp_options(**kwargs)

DHCPオプションの設定情報を取得します。

DHCPオプションを指定するためには、DHCPオプションが必要です。

DHCPオプションを指定しない場合は、取得可能なすべてのDHCPオプション情報を取得します。

絞り込み条件の項目の値「Filter.n.Value.m」を指定する際、ワイルドカード文字（曖昧検索）指定可能です。「∗」は0個以上任意文字、 「?」は1個任意文字、「¥」はエスケープ変換文字（「∗niftycloud¥?¥¥」は「∗niftycloud?¥」を検索）となります。

曖昧検索が指定可能な絞り込み条件の項目名は、key、valueになります。

See also: NIFCLOUD API Documentation

Request Syntax

response = client.describe_dhcp_options(
    DhcpOptionsId=[
        'string',
    ],
    Filter=[
        {
            'ListOfRequestValue': [
                'string',
            ],
            'Name': 'dhcp-options-id'|'key'|'value'
        },
    ]
)

Parameters:

• DhcpOptionsId (list) –

  • (string) –

• Filter (list) –

  • (dict) –

    • ListOfRequestValue (list) –

      • (string) –

    • Name (string) –

Return type:

dict

Returns:

Response Syntax

{
    'DhcpOptionsSet': [
        {
            'DhcpConfigurationSet': [
                {
                    'Key': 'string',
                    'ValueSet': [
                        {
                            'Value': 'string'
                        },
                    ]
                },
            ],
            'DhcpOptionsId': 'string'
        },
    ],
    'RequestId': 'string'
}

Response Structure

• (dict) –

  • DhcpOptionsSet (list) –

    • (dict) –

      • DhcpConfigurationSet (list) –

        • (dict) –

          • Key (string) –

          • ValueSet (list) –

            • (dict) –

              • Value (string) –

      • DhcpOptionsId (string) –

  • RequestId (string) –