computing / Client / nifty_describe_dhcp_configs

nifty_describe_dhcp_configs

computing.Client.nifty_describe_dhcp_configs(**kwargs)

DHCPコンフィグ情報を取得します。

DHCPコンフィグを指定するためには、DHCPコンフィグIDが必要です。DHCPコンフィグを指定しない場合は、取得可能なすべてのDHCPコンフィグ情報を取得します。

絞り込み条件の項目の値「Filter.n.Value.m」を指定する際、ワイルドカード文字（曖昧検索）指定可能です。

「∗」は0個以上任意文字、「?」は1個任意文字、「」はエスケープ変換文字（「∗niftycloud¥?¥¥」は「∗niftycloud?¥」を検索）となります。

曖昧検索が指定可能な絞り込み条件の項目名は、ipaddress-pool-start, ipaddress-pool-stop, ipaddress-pool-description, static-mapping-ipaddress, static-mapping-macaddress, static-mapping-descriptionになります。

See also: NIFCLOUD API Documentation

Request Syntax

response = client.nifty_describe_dhcp_configs(
    DhcpConfigId=[
        'string',
    ],
    Filter=[
        {
            'ListOfRequestValue': [
                'string',
            ],
            'Name': 'dhcp-config-id'|'ipaddress-pool-start'|'ipaddress-pool-stop'|'ipaddress-pool-description'|'static-mapping-ipaddress'|'static-mapping-macaddress'|'static-mapping-description'
        },
    ]
)

Parameters:

• DhcpConfigId (list) –

  • (string) –

• Filter (list) –

  • (dict) –

    • ListOfRequestValue (list) –

      • (string) –

    • Name (string) –

Return type:

dict

Returns:

Response Syntax

{
    'DhcpConfigsSet': [
        {
            'DhcpConfigId': 'string',
            'IpAddressPoolsSet': [
                {
                    'Description': 'string',
                    'StartIpAddress': 'string',
                    'StopIpAddress': 'string'
                },
            ],
            'StaticMappingsSet': [
                {
                    'Description': 'string',
                    'IpAddress': 'string',
                    'MacAddress': 'string'
                },
            ]
        },
    ],
    'RequestId': 'string'
}

Response Structure

• (dict) –

  • DhcpConfigsSet (list) –

    • (dict) –

      • DhcpConfigId (string) –

      • IpAddressPoolsSet (list) –

        • (dict) –

          • Description (string) –

          • StartIpAddress (string) –

          • StopIpAddress (string) –

      • StaticMappingsSet (list) –

        • (dict) –

          • Description (string) –

          • IpAddress (string) –

          • MacAddress (string) –

  • RequestId (string) –