Method: JSS::Sitable#site=

Defined in:
lib/jss/api_object/sitable.rb

#site=(new_site) ⇒ void

This method returns an undefined value.

Change the site of this object. Any of the NON_SITES values will unset the site

Parameters:

  • new_site (Integer, String) —

    The new site

Raises:


120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/jss/api_object/sitable.rb', line 120

def site=(new_site)
  return nil unless updatable? || creatable?

  # unset the site? Use nil or an empty string
  if NON_SITES.include? new_site
    unset_site
    return
  end

  new_id = JSS::Site.valid_id new_site, api: @api
  new_name = JSS::Site.map_all_ids_to(:name, api: @api)[new_id]
  # no change, go home.
  return nil if new_name == @site_name

  raise JSS::NoSuchItemError, "Site '#{new_site}' is not known to the JSS" unless new_id

  @site_name = new_name
  @site_id = new_id
  @need_to_update = true
end