Class: ForemanApi::Resources::Subnet

Inherits:
Base
  • Object
show all
Defined in:
lib/foreman_api/resources/subnet.rb

Class Method Summary (collapse)

Instance Method Summary (collapse)

Class Method Details

+ (Object) doc



4
5
6
# File 'lib/foreman_api/resources/subnet.rb', line 4

def self.doc
  @doc ||= ForemanApi.doc['resources']["subnets"]
end

Instance Method Details

- (Array) create(params = {}, headers = {})

Returns First item: parsed data; second item: raw body

Parameters:

  • params (Hash) (defaults to: {})

    a hash of params to be passed to the service

  • headers (Hash) (defaults to: {})

    additional http headers

Options Hash (params):

  • subnet (Hash, nil)

    allowed keys are:

    • dhcp_id [String, nil] dhcp proxy to use within this subnet

    • dns_id [String, nil] dns proxy to use within this subnet

    • domain_ids [Array, nil] domains in which this subnet is part

    • tftp_id [String, nil] tftp proxy to use within this subnet

    • dns_primary [String, nil] primary dns for this subnet

    • dns_secondary [String, nil] secondary dns for this subnet

    • from [String, nil] starting ip address for ip auto suggestion

    • gateway [String, nil] primary dns for this subnet

    • mask [String] netmask for this subnet

    • name [String] subnet name

    • network [String] subnet network

    • to [String, nil] ending ip address for ip auto suggestion

    • vlanid [String, nil] vlan id for this subnet

Returns:

  • (Array)

    First item: parsed data; second item: raw body



48
49
50
# File 'lib/foreman_api/resources/subnet.rb', line 48

def create(params = {}, headers = {})
  perform_call(__method__, params, headers)
end

- (Array) destroy(params = {}, headers = {})

Returns First item: parsed data; second item: raw body

Parameters:

  • params (Hash) (defaults to: {})

    a hash of params to be passed to the service

  • headers (Hash) (defaults to: {})

    additional http headers

Options Hash (params):

  • id (String)

    subnet numeric identifier

Returns:

  • (Array)

    First item: parsed data; second item: raw body



81
82
83
# File 'lib/foreman_api/resources/subnet.rb', line 81

def destroy(params = {}, headers = {})
  perform_call(__method__, params, headers)
end

- (Array) index(params = {}, headers = {})

Returns First item: parsed data; second item: raw body

Parameters:

  • params (Hash) (defaults to: {})

    a hash of params to be passed to the service

  • headers (Hash) (defaults to: {})

    additional http headers

Options Hash (params):

  • order (String)

    sort results

  • page (String)

    paginate results

  • per_page (String)

    number of entries per request

  • search (String)

    filter results

Returns:

  • (Array)

    First item: parsed data; second item: raw body



16
17
18
# File 'lib/foreman_api/resources/subnet.rb', line 16

def index(params = {}, headers = {})
  perform_call(__method__, params, headers)
end

- (Array) show(params = {}, headers = {})

Returns First item: parsed data; second item: raw body

Parameters:

  • params (Hash) (defaults to: {})

    a hash of params to be passed to the service

  • headers (Hash) (defaults to: {})

    additional http headers

Options Hash (params):

  • id (String)

Returns:

  • (Array)

    First item: parsed data; second item: raw body



25
26
27
# File 'lib/foreman_api/resources/subnet.rb', line 25

def show(params = {}, headers = {})
  perform_call(__method__, params, headers)
end

- (Array) update(params = {}, headers = {})

Returns First item: parsed data; second item: raw body

Parameters:

  • params (Hash) (defaults to: {})

    a hash of params to be passed to the service

  • headers (Hash) (defaults to: {})

    additional http headers

Options Hash (params):

  • id (String)

    subnet numeric identifier

  • subnet (Hash, nil)

    allowed keys are:

    • dhcp_id [String, nil] dhcp proxy to use within this subnet

    • dns_id [String, nil] dns proxy to use within this subnet

    • domain_ids [Array, nil] domains in which this subnet is part

    • tftp_id [String, nil] tftp proxy to use within this subnet

    • dns_primary [String, nil] primary dns for this subnet

    • dns_secondary [String, nil] secondary dns for this subnet

    • from [String, nil] starting ip address for ip auto suggestion

    • gateway [String, nil] primary dns for this subnet

    • mask [String] netmask for this subnet

    • name [String] subnet name

    • network [String] subnet network

    • to [String, nil] ending ip address for ip auto suggestion

    • vlanid [String, nil] vlan id for this subnet

Returns:

  • (Array)

    First item: parsed data; second item: raw body



72
73
74
# File 'lib/foreman_api/resources/subnet.rb', line 72

def update(params = {}, headers = {})
  perform_call(__method__, params, headers)
end