Retrieving Network and Service Objects

The following methods retrieve information about network and service objects.

Retrieving a List of all Network Object Information

The get_all_hostgroups method retrieves a list of all network object information for every device defined in AFA.

Request Type: GetAllHostGroupsRequest

Element

Type

Description

SessionIDMandatory

String

Session ID obtained from the connect method.

Response Type: GetAllHostGroupsResponse

Element

Type

Description

HostGroup

List of HostGroup objects

List of host group information. See HostGroup Type (see HostGroup type ).

Request example:

<GetAllHostGroupsRequest>
    <SessionID>tbuumksnrvj8mqslos2gfhrdl2</SessionID>
</GetAllHostGroupsRequest>

Response example:

<GetAllHostGroupsResponse>
    <HostGroup>
        <EntityID>m_10_132_31_1</EntityID>
        <Name>gg_10.131.32.11-13-43</Name>
        <CanonizedName>gg_10.131.32.11-13-43</CanonizedName>
        <IP>
            <xsd:string>10.131.32.11-10.131.32.13</xsd:string>
            <xsd:string>10.131.32.15</xsd:string>
            <xsd:string>10.131.32.43</xsd:string>
         </IP>
         <ClassName>network_object_group</ClassName>
         <Members>
            <xsd:string>a_10.131.32.43</xsd:string>
            <xsd:string>a_10.131.32.15</xsd:string>
            <xsd:string>aa_10.131.32.12-13</xsd:string>
            <xsd:string>aa_10.131.32.11</xsd:string>
         </Members>
    </HostGroup>
    <HostGroup>
        <EntityID>m_10_132_31_1</EntityID>
        <Name>a_10.131.23.14</Name>
        <CanonizedName>a_10.131.23.14</CanonizedName>
        <IP>
            <xsd:string>10.131.23.14</xsd:string>
        </IP>
        <ClassName>host_plain</ClassName>
        <Members>
            <xsd:string/>
        </Members>
    </HostGroup>
</GetAllHostGroupsResponse>

Retrieving a Device's Network Object Information

The get_hostgroups_by_device method retrieves a list of a device's network object information.

Request Type: GetHostGroupsRequest

Element

Type

Description

SessionIDMandatory

String

Session ID obtained from the connect method.

EntityIDMandatory

String

Entity ID of the device.

Response Type: GetHostGroupsResponse

Element

Type

Description

HostGroup

List of HostGroup objects

List of host groups. See HostGroup type .

Request example:

<GetHostGroupsRequest>
    <SessionID>tbuumksnrvj8mqslos2gfhrdl2</SessionID>
    <EntityID>m_10_132_31_1</EntityID>
</GetHostGroupsRequest>

Response example:

<GetHostGroupsResponse>
    <HostGroup>
        <EntityID>m_10_132_31_1</EntityID>
        <Name>gg_10.131.32.11-13-43</OriginalName>
        <CanonizedName>gg_10.131.32.11-13-43</CanonizedName>
        <IP>
            <xsd:string>10.131.32.11-10.131.32.13</xsd:string>
            <xsd:string>10.131.32.15</xsd:string>
            <xsd:string>10.131.32.43</xsd:string>
        </IP>
        <ClassName>network_object_group</ClassName>
        <Members>
            <xsd:string>a_10.131.32.43</xsd:string>
            <xsd:string>a_10.131.32.15</xsd:string>
            <xsd:string>aa_10.131.32.12-13</xsd:string>
            <xsd:string>aa_10.131.32.11</xsd:string>
        </Members>
    </HostGroup>
    <HostGroup>
        <EntityID>m_10_132_31_1</EntityID>
        <Name>a_10.131.23.14</OriginalName>
        <CanonizedName>a_10.131.23.14</CanonizedName>
        <IP>
            <xsd:string>10.131.23.14</xsd:string>
        </IP>
        <ClassName>host_plain</ClassName>
        <Members>
            <xsd:string/>
        </Members>
    </HostGroup>
</GetHostGroupsResponse>

Retrieving a Network Object's Information

The get_hostgroup_by_name_and_device method retrieves information about a a specific network object, given its name and the device it is defined on.

Request Type: GetHostGroupNameDeviceRequest

Element

Type

Description

SessionIDMandatory

String

Session ID obtained from the connect method.

EntityIDMandatory

String

Entity ID of the device.

HostGroupNameMandatory

String

Original name of the host group.

Response Type: GetHostGroupNameDeviceResponse

Element

Type

Description

HostGroupMandatory

A HostGroup object

Host group information. See HostGroup Type (see HostGroup type ).

Request example:

<GetHostGroupNameDeviceRequest>
    <SessionID>tbuumksnrvj8mqslos2gfhrdl2</SessionID>
    <EntityID>m_10_132_31_1</EntityID>
    <HostGroupName>EW1662d11345</HostGroupName>
</GetHostGroupNameDeviceRequest>

Response example:

<GetHostGroupNameDeviceResponse>
    <HostGroup>
        <EntityID>m_10_132_31_1</EntityID>
        <HostGroupName>EW1662d11345</HostGroupName>
        <CanonizedName>EW1662d11345</CanonizedName>
        <IP>
            <xsd:string>10.131.32.35</xsd:string>
        </IP>
        <ClassName>host_plain</ClassName>
        <Members>
            <xsd:string/>
        </Members>
    </HostGroup>
</GetHostGroupNameDeviceResponse>

Retrieving a List of all Service Object Information

The get_all_services method retrieves a list of all service object information for every device defined in AFA.

Request Type: GetAllServicesRequest

Element

Type

Description

SessionIDMandatory

String

Session ID obtained from the connect method.

Response Type: GetAllServicesResponse

Element

Type

Description

Service

List of ServiceInfo objects

Service information. See ServiceInfo Type (see ServiceInfo type ).

Request example:

<GetAllServicesRequest>
    <SessionID>c25uvd7g58qv0a1r1ht65ep1j0</SessionID>
</GetAllServicesRequest>

Response example:

<GetAllServicesResponse>
    <Service>
        <EntityID>Alon_Cluster</EntityID>
        <Name>microsoft_rpc_http</Name>
        <Ports>
            <Port>TCP/593</Port>
        </Ports>
    </Service>
    <Service>
        <EntityID>Alon_Cluster</EntityID>
        <Name>Microsoft_services</Name>
        <Ports>
            <Port>UDP/138</Port>
            <Port>UDP/137</Port>
        </Ports>
    </Service>
    <Service>
        <EntityID>Alon_Cluster</EntityID>
        <Name>Microsoft_services</Name>
        <Ports>
            <Port>TCP/139</Port>
            <Port>TCP/445</Port>
            <Port>TCP/135</Port>
            <Port>TCP/593</Port>
        </Ports>
    </Service>
</GetAllServicesResponse>

Retrieving a Device's Service Object Information

The get_services_by_device method retrieves a list of a device's service object information.

Request Type: GetServicesDeviceRequest

Element

Type

Description

SessionIDMandatory

String

Session ID obtained from the connect method.

DeviceIDMandatory

String

Tree name of the device.

Response Type: GetServicesDeviceResponse

Element

Type

Description

Service

List of ServiceInfo objects

List of service information. See ServiceInfo Type (see ServiceInfo type ).

Request example:

<GetServicesDeviceRequest>
    <SessionID>c25uvd7g58qv0a1r1ht65ep1j0</SessionID>
    <DeviceID>10_132_20_1_root</DeviceID>
</GetServicesDeviceRequest>

Response example:

<GetServicesDeviceResponse>
    <Service>
        <DeviceID>10_132_20_1_root</DeviceID>
        <Name>AFS3</Name>
        <Ports>
            <Port>UDP/7000-7009</Port>
        </Ports>
    </Service>
    <Service>
        <DeviceID>10_132_20_1_root</DeviceID>
        <Name>AH</Name>
        <Ports>
            <Port>51/0-65535</Port>
        </Ports>
    </Service>
    <Service>
        <DeviceID>10_132_20_1_root</DeviceID>
        <Name>Algosec_Client_IM_ports_allowed</Name>
        <Ports>
            <Port>TCP/1863</Port>
            <Port>TCP/5190</Port>
            <Port>TCP/5222</Port>
        </Ports>
    </Service>
</GetServicesDeviceResponse>

Retrieving a Service Object's Information

The get_service_by_name_and_device method retrieves information about a a specific service object, given its name and the device it is defined on.

Request Type: GetServiceNameDeviceRequest

Element

Type

Description

SessionIDMandatory

String

Session ID obtained from the connect method.

DeviceIDMandatory

String

Tree name of the device.

NameMandatory

String

Name of the service.

Response Type: GetServiceNameDeviceResponse

Element

Type

Description

Service

List of ServiceInfo objects

List of service information. See ServiceInfo Type (see ServiceInfo type ).

Request example:

<GetServicesNameDeviceRequest>
    <SessionID>c25uvd7g58qv0a1r1ht65ep1j0</SessionID>
    <DeviceID>10_132_20_1_root</DeviceID>
    <Name>AFS3</Name>
</GetServicesNameDeviceRequest>

Response example:

<ns1:GetServiceNameDeviceResponse>
    <Service>
        <DeviceID>10_132_20_1_root</DeviceID>
        <Name>AFS3</Name>
        <Ports>
            <Port>TCP/7000-7009</Port>
        </Ports>
    </Service>
    <Service>
        <DeviceID>10_132_20_1_root</DeviceID>
        <Name>AFS3</Name>
        <Ports>
            <Port>UDP/7000-7009</Port>
        </Ports>
    </Service>
</GetServiceNameDeviceResponse>